1
# Copyright (C) 2005, 2006, 2007 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
47
class _OSLock(object):
53
def _open(self, filename, filemode):
54
self.filename = osutils.realpath(filename)
56
self.f = open(self.filename, filemode)
59
if e.errno in (errno.EACCES, errno.EPERM):
60
raise errors.LockFailed(self.filename, str(e))
61
if e.errno != errno.ENOENT:
64
# maybe this is an old branch (before may 2005)
65
trace.mutter("trying to create missing lock %r", self.filename)
67
self.f = open(self.filename, 'wb+')
71
"""Clear the self.f attribute cleanly."""
78
from warnings import warn
79
warn("lock on %r not released" % self.f)
83
raise NotImplementedError()
93
if sys.platform == 'win32':
95
import win32con, win32file, pywintypes, winerror, msvcrt
105
LOCK_SH = fcntl.LOCK_SH
106
LOCK_NB = fcntl.LOCK_NB
107
lock_EX = fcntl.LOCK_EX
110
class _fcntl_FileLock(_OSLock):
113
fcntl.lockf(self.f, fcntl.LOCK_UN)
117
class _fcntl_WriteLock(_fcntl_FileLock):
121
def __init__(self, filename):
122
super(_fcntl_WriteLock, self).__init__()
123
# Check we can grab a lock before we actually open the file.
124
self.filename = osutils.realpath(filename)
125
if self.filename in _fcntl_WriteLock._open_locks:
127
raise errors.LockContention(self.filename)
129
self._open(self.filename, 'rb+')
130
# reserve a slot for this lock - even if the lockf call fails,
131
# at thisi point unlock() will be called, because self.f is set.
132
# TODO: make this fully threadsafe, if we decide we care.
133
_fcntl_WriteLock._open_locks.add(self.filename)
135
# LOCK_NB will cause IOError to be raised if we can't grab a
137
fcntl.lockf(self.f, fcntl.LOCK_EX | fcntl.LOCK_NB)
139
if e.errno in (errno.EAGAIN, errno.EACCES):
140
# We couldn't grab the lock
142
# we should be more precise about whats a locking
143
# error and whats a random-other error
144
raise errors.LockContention(e)
147
_fcntl_WriteLock._open_locks.remove(self.filename)
151
class _fcntl_ReadLock(_fcntl_FileLock):
155
def __init__(self, filename):
156
super(_fcntl_ReadLock, self).__init__()
157
self.filename = osutils.realpath(filename)
158
_fcntl_ReadLock._open_locks.setdefault(self.filename, 0)
159
_fcntl_ReadLock._open_locks[self.filename] += 1
160
self._open(filename, 'rb')
162
# LOCK_NB will cause IOError to be raised if we can't grab a
164
fcntl.lockf(self.f, fcntl.LOCK_SH | fcntl.LOCK_NB)
166
# we should be more precise about whats a locking
167
# error and whats a random-other error
168
raise errors.LockContention(e)
171
count = _fcntl_ReadLock._open_locks[self.filename]
173
del _fcntl_ReadLock._open_locks[self.filename]
175
_fcntl_ReadLock._open_locks[self.filename] = count - 1
178
def temporary_write_lock(self):
179
"""Try to grab a write lock on the file.
181
On platforms that support it, this will upgrade to a write lock
182
without unlocking the file.
183
Otherwise, this will release the read lock, and try to acquire a
186
:return: A token which can be used to switch back to a read lock.
188
assert self.filename not in _fcntl_WriteLock._open_locks
190
wlock = _fcntl_TemporaryWriteLock(self)
191
except errors.LockError:
192
# We didn't unlock, so we can just return 'self'
197
class _fcntl_TemporaryWriteLock(_OSLock):
198
"""A token used when grabbing a temporary_write_lock.
200
Call restore_read_lock() when you are done with the write lock.
203
def __init__(self, read_lock):
204
super(_fcntl_TemporaryWriteLock, self).__init__()
205
self._read_lock = read_lock
206
self.filename = read_lock.filename
208
count = _fcntl_ReadLock._open_locks[self.filename]
210
# Something else also has a read-lock, so we cannot grab a
212
raise errors.LockContention(self.filename)
214
assert self.filename not in _fcntl_WriteLock._open_locks
216
# See if we can open the file for writing. Another process might
217
# have a read lock. We don't use self._open() because we don't want
218
# to create the file if it exists. That would have already been
219
# done by _fcntl_ReadLock
221
new_f = open(self.filename, 'rb+')
223
if e.errno in (errno.EACCES, errno.EPERM):
224
raise errors.LockFailed(self.filename, str(e))
227
# LOCK_NB will cause IOError to be raised if we can't grab a
229
fcntl.lockf(new_f, fcntl.LOCK_EX | fcntl.LOCK_NB)
231
# TODO: Raise a more specific error based on the type of error
232
raise errors.LockContention(e)
233
_fcntl_WriteLock._open_locks.add(self.filename)
237
def restore_read_lock(self):
238
"""Restore the original ReadLock."""
239
# For fcntl, since we never released the read lock, just release the
240
# write lock, and return the original lock.
241
fcntl.lockf(self.f, fcntl.LOCK_UN)
243
_fcntl_WriteLock._open_locks.remove(self.filename)
244
# Avoid reference cycles
245
read_lock = self._read_lock
246
self._read_lock = None
250
_lock_classes.append(('fcntl', _fcntl_WriteLock, _fcntl_ReadLock))
253
if have_pywin32 and sys.platform == 'win32':
254
LOCK_SH = 0 # the default
255
LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
256
LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
259
class _w32c_FileLock(_OSLock):
261
def _lock(self, filename, openmode, lockmode):
262
self._open(filename, openmode)
264
self.hfile = msvcrt.get_osfhandle(self.f.fileno())
265
overlapped = pywintypes.OVERLAPPED()
267
win32file.LockFileEx(self.hfile, lockmode, 0, 0x7fff0000,
269
except pywintypes.error, e:
271
if e.args[0] in (winerror.ERROR_LOCK_VIOLATION,):
272
raise errors.LockContention(filename)
273
## import pdb; pdb.set_trace()
277
raise errors.LockContention(e)
280
overlapped = pywintypes.OVERLAPPED()
282
win32file.UnlockFileEx(self.hfile, 0, 0x7fff0000, overlapped)
285
raise errors.LockContention(e)
288
class _w32c_ReadLock(_w32c_FileLock):
289
def __init__(self, filename):
290
super(_w32c_ReadLock, self).__init__()
291
self._lock(filename, 'rb', LOCK_SH + LOCK_NB)
293
def temporary_write_lock(self):
294
"""Try to grab a write lock on the file.
296
On platforms that support it, this will upgrade to a write lock
297
without unlocking the file.
298
Otherwise, this will release the read lock, and try to acquire a
301
:return: A token which can be used to switch back to a read lock.
303
# I can't find a way to upgrade a read lock to a write lock without
304
# unlocking first. So here, we do just that.
307
wlock = _w32c_WriteLock(self.filename)
308
except errors.LockError:
309
return False, _w32c_ReadLock(self.filename)
313
class _w32c_WriteLock(_w32c_FileLock):
314
def __init__(self, filename):
315
super(_w32c_WriteLock, self).__init__()
316
self._lock(filename, 'rb+', LOCK_EX + LOCK_NB)
318
def restore_read_lock(self):
319
"""Restore the original ReadLock."""
320
# For win32 we had to completely let go of the original lock, so we
321
# just unlock and create a new read lock.
323
return _w32c_ReadLock(self.filename)
326
_lock_classes.append(('pywin32', _w32c_WriteLock, _w32c_ReadLock))
329
have_ctypes_win32 = False
330
if sys.platform == 'win32':
332
import ctypes, msvcrt
333
have_ctypes_win32 = True
337
if have_ctypes_win32:
338
# These constants were copied from the win32con.py module.
339
LOCKFILE_FAIL_IMMEDIATELY = 1
340
LOCKFILE_EXCLUSIVE_LOCK = 2
341
# Constant taken from winerror.py module
342
ERROR_LOCK_VIOLATION = 33
345
LOCK_EX = LOCKFILE_EXCLUSIVE_LOCK
346
LOCK_NB = LOCKFILE_FAIL_IMMEDIATELY
347
_LockFileEx = ctypes.windll.kernel32.LockFileEx
348
_UnlockFileEx = ctypes.windll.kernel32.UnlockFileEx
349
_GetLastError = ctypes.windll.kernel32.GetLastError
351
### Define the OVERLAPPED structure.
352
# http://msdn2.microsoft.com/en-us/library/ms684342.aspx
353
# typedef struct _OVERLAPPED {
354
# ULONG_PTR Internal;
355
# ULONG_PTR InternalHigh;
366
class _inner_struct(ctypes.Structure):
367
_fields_ = [('Offset', ctypes.c_uint), # DWORD
368
('OffsetHigh', ctypes.c_uint), # DWORD
371
class _inner_union(ctypes.Union):
372
_fields_ = [('anon_struct', _inner_struct), # struct
373
('Pointer', ctypes.c_void_p), # PVOID
376
class OVERLAPPED(ctypes.Structure):
377
_fields_ = [('Internal', ctypes.c_void_p), # ULONG_PTR
378
('InternalHigh', ctypes.c_void_p), # ULONG_PTR
379
('_inner_union', _inner_union),
380
('hEvent', ctypes.c_void_p), # HANDLE
383
class _ctypes_FileLock(_OSLock):
385
def _lock(self, filename, openmode, lockmode):
386
self._open(filename, openmode)
388
self.hfile = msvcrt.get_osfhandle(self.f.fileno())
389
overlapped = OVERLAPPED()
390
result = _LockFileEx(self.hfile, # HANDLE hFile
391
lockmode, # DWORD dwFlags
392
0, # DWORD dwReserved
393
0x7fffffff, # DWORD nNumberOfBytesToLockLow
394
0x00000000, # DWORD nNumberOfBytesToLockHigh
395
ctypes.byref(overlapped), # lpOverlapped
399
last_err = _GetLastError()
400
if last_err in (ERROR_LOCK_VIOLATION,):
401
raise errors.LockContention(filename)
402
raise errors.LockContention('Unknown locking error: %s'
406
overlapped = OVERLAPPED()
407
result = _UnlockFileEx(self.hfile, # HANDLE hFile
408
0, # DWORD dwReserved
409
0x7fffffff, # DWORD nNumberOfBytesToLockLow
410
0x00000000, # DWORD nNumberOfBytesToLockHigh
411
ctypes.byref(overlapped), # lpOverlapped
416
last_err = _GetLastError()
417
raise errors.LockContention('Unknown unlocking error: %s'
421
class _ctypes_ReadLock(_ctypes_FileLock):
422
def __init__(self, filename):
423
super(_ctypes_ReadLock, self).__init__()
424
self._lock(filename, 'rb', LOCK_SH + LOCK_NB)
426
def temporary_write_lock(self):
427
"""Try to grab a write lock on the file.
429
On platforms that support it, this will upgrade to a write lock
430
without unlocking the file.
431
Otherwise, this will release the read lock, and try to acquire a
434
:return: A token which can be used to switch back to a read lock.
436
# I can't find a way to upgrade a read lock to a write lock without
437
# unlocking first. So here, we do just that.
440
wlock = _ctypes_WriteLock(self.filename)
441
except errors.LockError:
442
return False, _ctypes_ReadLock(self.filename)
445
class _ctypes_WriteLock(_ctypes_FileLock):
446
def __init__(self, filename):
447
super(_ctypes_WriteLock, self).__init__()
448
self._lock(filename, 'rb+', LOCK_EX + LOCK_NB)
450
def restore_read_lock(self):
451
"""Restore the original ReadLock."""
452
# For win32 we had to completely let go of the original lock, so we
453
# just unlock and create a new read lock.
455
return _ctypes_ReadLock(self.filename)
458
_lock_classes.append(('ctypes', _ctypes_WriteLock, _ctypes_ReadLock))
461
if len(_lock_classes) == 0:
462
raise NotImplementedError(
463
"We must have one of fcntl, pywin32, or ctypes available"
464
" to support OS locking."
468
# We default to using the first available lock class.
469
_lock_type, WriteLock, ReadLock = _lock_classes[0]
added
removed
bzrlib/lock.py
