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
46
class _base_Lock(object):
52
def _open(self, filename, filemode):
53
self.filename = osutils.realpath(filename)
55
self.f = open(self.filename, filemode)
58
if e.errno in (errno.EACCES, errno.EPERM):
59
raise errors.ReadOnlyLockError(self.filename, str(e))
60
if e.errno != errno.ENOENT:
63
# maybe this is an old branch (before may 2005)
64
trace.mutter("trying to create missing lock %r", self.filename)
66
self.f = open(self.filename, 'wb+')
70
"""Clear the self.f attribute cleanly."""
77
from warnings import warn
78
warn("lock on %r not released" % self.f)
82
raise NotImplementedError()
91
import win32con, win32file, pywintypes, winerror, msvcrt
106
LOCK_SH = fcntl.LOCK_SH
107
LOCK_NB = fcntl.LOCK_NB
108
lock_EX = fcntl.LOCK_EX
111
class _fcntl_FileLock(_base_Lock):
114
fcntl.lockf(self.f, fcntl.LOCK_UN)
118
class _fcntl_WriteLock(_fcntl_FileLock):
122
def __init__(self, filename):
123
super(_fcntl_WriteLock, self).__init__()
124
# Check we can grab a lock before we actually open the file.
125
self.filename = osutils.realpath(filename)
126
if (self.filename in _fcntl_WriteLock._open_locks
127
or self.filename in _fcntl_ReadLock._open_locks):
129
raise errors.LockContention(self.filename)
131
self._open(self.filename, 'rb+')
132
# reserve a slot for this lock - even if the lockf call fails,
133
# at thisi point unlock() will be called, because self.f is set.
134
# TODO: make this fully threadsafe, if we decide we care.
135
_fcntl_WriteLock._open_locks.add(self.filename)
137
# LOCK_NB will cause IOError to be raised if we can't grab a
139
fcntl.lockf(self.f, fcntl.LOCK_EX | fcntl.LOCK_NB)
141
if e.errno in (errno.EAGAIN, errno.EACCES):
142
# We couldn't grab the lock
144
# we should be more precise about whats a locking
145
# error and whats a random-other error
146
raise errors.LockError(e)
149
_fcntl_WriteLock._open_locks.remove(self.filename)
153
class _fcntl_ReadLock(_fcntl_FileLock):
157
def __init__(self, filename, _ignore_write_lock=False):
158
super(_fcntl_ReadLock, self).__init__()
159
self.filename = osutils.realpath(filename)
160
if not _ignore_write_lock and self.filename in _fcntl_WriteLock._open_locks:
161
raise errors.LockContention(self.filename)
162
_fcntl_ReadLock._open_locks.setdefault(self.filename, 0)
163
_fcntl_ReadLock._open_locks[self.filename] += 1
164
self._open(filename, 'rb')
166
# LOCK_NB will cause IOError to be raised if we can't grab a
168
fcntl.lockf(self.f, fcntl.LOCK_SH | fcntl.LOCK_NB)
170
# we should be more precise about whats a locking
171
# error and whats a random-other error
172
raise errors.LockError(e)
175
count = _fcntl_ReadLock._open_locks[self.filename]
177
del _fcntl_ReadLock._open_locks[self.filename]
179
_fcntl_ReadLock._open_locks[self.filename] = count - 1
182
def temporary_write_lock(self):
183
"""Try to grab a write lock on the file.
185
On platforms that support it, this will upgrade to a write lock
186
without unlocking the file.
187
Otherwise, this will release the read lock, and try to acquire a
190
:return: A token which can be used to switch back to a read lock.
192
assert self.filename not in _fcntl_WriteLock._open_locks
194
wlock = _fcntl_TemporaryWriteLock(self)
195
except errors.LockError:
196
# We didn't unlock, so we can just return 'self'
201
class _fcntl_TemporaryWriteLock(_base_Lock):
202
"""A token used when grabbing a temporary_write_lock.
204
Call restore_read_lock() when you are done with the write lock.
207
def __init__(self, read_lock):
208
super(_fcntl_TemporaryWriteLock, self).__init__()
209
self._read_lock = read_lock
210
self.filename = read_lock.filename
212
count = _fcntl_ReadLock._open_locks[self.filename]
214
# Something else also has a read-lock, so we cannot grab a
216
raise errors.LockContention(self.filename)
218
assert self.filename not in _fcntl_WriteLock._open_locks
220
# See if we can open the file for writing. Another process might
221
# have a read lock. We don't use self._open() because we don't want
222
# to create the file if it exists. That would have already been
223
# done by _fcntl_ReadLock
225
new_f = open(self.filename, 'rb+')
227
if e.errno in (errno.EACCES, errno.EPERM):
228
raise errors.ReadOnlyLockError(self.filename, str(e))
231
# LOCK_NB will cause IOError to be raised if we can't grab a
233
fcntl.lockf(new_f, fcntl.LOCK_SH | fcntl.LOCK_NB)
235
# TODO: Raise a more specific error based on the type of error
236
raise errors.LockError(e)
237
_fcntl_WriteLock._open_locks.add(self.filename)
241
def restore_read_lock(self):
242
"""Restore the original ReadLock."""
243
# For fcntl, since we never released the read lock, just release the
244
# write lock, and return the original lock.
245
fcntl.lockf(self.f, fcntl.LOCK_UN)
247
_fcntl_WriteLock._open_locks.remove(self.filename)
248
# Avoid reference cycles
249
read_lock = self._read_lock
250
self._read_lock = None
254
_lock_classes.append(('fcntl', _fcntl_WriteLock, _fcntl_ReadLock))
258
LOCK_SH = 0 # the default
259
LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
260
LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
263
class _w32c_FileLock(_base_Lock):
265
def _lock(self, filename, openmode, lockmode):
266
self._open(filename, openmode)
268
self.hfile = msvcrt.get_osfhandle(self.f.fileno())
269
overlapped = pywintypes.OVERLAPPED()
271
win32file.LockFileEx(self.hfile, lockmode, 0, 0x7fff0000,
273
except pywintypes.error, e:
275
if e.args[0] in (winerror.ERROR_LOCK_VIOLATION,):
276
raise errors.LockContention(filename)
277
## import pdb; pdb.set_trace()
281
raise errors.LockError(e)
284
overlapped = pywintypes.OVERLAPPED()
286
win32file.UnlockFileEx(self.hfile, 0, 0x7fff0000, overlapped)
289
raise errors.LockError(e)
292
class _w32c_ReadLock(_w32c_FileLock):
293
def __init__(self, filename):
294
super(_w32c_ReadLock, self).__init__()
295
self._lock(filename, 'rb', LOCK_SH + LOCK_NB)
297
def temporary_write_lock(self):
298
"""Try to grab a write lock on the file.
300
On platforms that support it, this will upgrade to a write lock
301
without unlocking the file.
302
Otherwise, this will release the read lock, and try to acquire a
305
:return: A token which can be used to switch back to a read lock.
307
# I can't find a way to upgrade a read lock to a write lock without
308
# unlocking first. So here, we do just that.
311
wlock = _w32c_WriteLock(self.filename)
312
except errors.LockError:
313
return False, _w32c_ReadLock(self.filename)
317
class _w32c_WriteLock(_w32c_FileLock):
318
def __init__(self, filename):
319
super(_w32c_WriteLock, self).__init__()
320
self._lock(filename, 'rb+', LOCK_EX + LOCK_NB)
322
def restore_read_lock(self):
323
"""Restore the original ReadLock."""
324
# For win32 we had to completely let go of the original lock, so we
325
# just unlock and create a new read lock.
327
return _w32c_ReadLock(self.filename)
330
_lock_classes.append(('pywin32', _w32c_WriteLock, _w32c_ReadLock))
334
# These constants were copied from the win32con.py module.
335
LOCKFILE_FAIL_IMMEDIATELY = 1
336
LOCKFILE_EXCLUSIVE_LOCK = 2
337
# Constant taken from winerror.py module
338
ERROR_LOCK_VIOLATION = 33
341
LOCK_EX = LOCKFILE_EXCLUSIVE_LOCK
342
LOCK_NB = LOCKFILE_FAIL_IMMEDIATELY
343
_LockFileEx = ctypes.windll.kernel32.LockFileEx
344
_UnlockFileEx = ctypes.windll.kernel32.UnlockFileEx
345
_GetLastError = ctypes.windll.kernel32.GetLastError
347
### Define the OVERLAPPED structure.
348
# http://msdn2.microsoft.com/en-us/library/ms684342.aspx
349
# typedef struct _OVERLAPPED {
350
# ULONG_PTR Internal;
351
# ULONG_PTR InternalHigh;
362
class _inner_struct(ctypes.Structure):
363
_fields_ = [('Offset', ctypes.c_uint), # DWORD
364
('OffsetHigh', ctypes.c_uint), # DWORD
367
class _inner_union(ctypes.Union):
368
_fields_ = [('anon_struct', _inner_struct), # struct
369
('Pointer', ctypes.c_void_p), # PVOID
372
class OVERLAPPED(ctypes.Structure):
373
_fields_ = [('Internal', ctypes.c_void_p), # ULONG_PTR
374
('InternalHigh', ctypes.c_void_p), # ULONG_PTR
375
('_inner_union', _inner_union),
376
('hEvent', ctypes.c_void_p), # HANDLE
379
class _ctypes_FileLock(_base_Lock):
381
def _lock(self, filename, openmode, lockmode):
382
self._open(filename, openmode)
384
self.hfile = msvcrt.get_osfhandle(self.f.fileno())
385
overlapped = OVERLAPPED()
386
p_overlapped = ctypes.pointer(overlapped)
387
result = _LockFileEx(self.hfile, # HANDLE hFile
388
lockmode, # DWORD dwFlags
389
0, # DWORD dwReserved
390
0x7fffffff, # DWORD nNumberOfBytesToLockLow
391
0x00000000, # DWORD nNumberOfBytesToLockHigh
392
p_overlapped, # lpOverlapped
396
last_err = _GetLastError()
397
if last_err in (ERROR_LOCK_VIOLATION,):
398
raise errors.LockContention(filename)
399
raise errors.LockError('Unknown locking error: %s'
403
overlapped = OVERLAPPED()
404
p_overlapped = ctypes.pointer(overlapped)
405
result = _UnlockFileEx(self.hfile, # HANDLE hFile
406
0, # DWORD dwReserved
407
0x7fffffff, # DWORD nNumberOfBytesToLockLow
408
0x00000000, # DWORD nNumberOfBytesToLockHigh
409
p_overlapped, # lpOverlapped
414
last_err = _GetLastError()
415
raise errors.LockError('Unknown unlocking error: %s'
419
class _ctypes_ReadLock(_ctypes_FileLock):
420
def __init__(self, filename):
421
super(_ctypes_ReadLock, self).__init__()
422
self._lock(filename, 'rb', LOCK_SH + LOCK_NB)
424
def temporary_write_lock(self):
425
"""Try to grab a write lock on the file.
427
On platforms that support it, this will upgrade to a write lock
428
without unlocking the file.
429
Otherwise, this will release the read lock, and try to acquire a
432
:return: A token which can be used to switch back to a read lock.
434
# I can't find a way to upgrade a read lock to a write lock without
435
# unlocking first. So here, we do just that.
438
wlock = _ctypes_WriteLock(self.filename)
439
except errors.LockError:
440
return False, _ctypes_ReadLock(self.filename)
443
class _ctypes_WriteLock(_ctypes_FileLock):
444
def __init__(self, filename):
445
super(_ctypes_WriteLock, self).__init__()
446
self._lock(filename, 'rb+', LOCK_EX + LOCK_NB)
448
def restore_read_lock(self):
449
"""Restore the original ReadLock."""
450
# For win32 we had to completely let go of the original lock, so we
451
# just unlock and create a new read lock.
453
return _ctypes_ReadLock(self.filename)
456
_lock_classes.append(('ctypes', _ctypes_WriteLock, _ctypes_ReadLock))
459
if len(_lock_classes) == 0:
460
raise NotImplementedError(
461
"We must have one of fcntl, pywin32, or ctypes available"
462
" to support OS locking."
466
# We default to using the first available lock class.
467
_lock_type, WriteLock, ReadLock = _lock_classes[0]
added
removed
bzrlib/lock.py
