1
# Copyright (C) 2005, 2006 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
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.
20
This only does local locking using OS locks for now.
24
22
This module causes two methods, lock() and unlock() to be defined in
25
23
any way that works on the current platform.
27
25
It is not specified whether these locks are reentrant (i.e. can be
28
26
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
41
from bzrlib.errors import LockError
42
from bzrlib.osutils import realpath
43
from bzrlib.trace import mutter
46
class _base_Lock(object):
48
def _open(self, filename, filemode):
50
self.f = open(filename, filemode)
53
if e.errno != errno.ENOENT:
56
# maybe this is an old branch (before may 2005)
57
mutter("trying to create missing branch lock %r", filename)
59
self.f = open(filename, 'wb+')
64
from warnings import warn
65
warn("lock on %r not released" % self.f)
69
raise NotImplementedError()
72
############################################################
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."""
36
from trace import mutter, note, warning
38
class LockError(Exception):
39
"""All exceptions from the lock/unlock functions should be from this exception class.
40
They will be translated as necessary. The original exception is available as e.original_error
42
def __init__(self, e=None):
43
self.original_error = e
45
Exception.__init__(self, e)
47
Exception.__init__(self)
79
class _fcntl_FileLock(_base_Lock):
84
fcntl.lockf(self.f, fcntl.LOCK_UN)
88
"""Clear the self.f attribute cleanly."""
93
class _fcntl_WriteLock(_fcntl_FileLock):
97
def __init__(self, filename):
98
# standard IO errors get exposed directly.
99
self._open(filename, 'wb')
101
self.filename = realpath(filename)
102
if self.filename in self.open_locks:
104
raise LockError("Lock already held.")
105
# reserve a slot for this lock - even if the lockf call fails,
106
# at thisi point unlock() will be called, because self.f is set.
107
# TODO: make this fully threadsafe, if we decide we care.
108
self.open_locks[self.filename] = self.filename
109
fcntl.lockf(self.f, fcntl.LOCK_EX)
111
# we should be more precise about whats a locking
112
# error and whats a random-other error
116
del self.open_locks[self.filename]
120
class _fcntl_ReadLock(_fcntl_FileLock):
122
def __init__(self, filename):
123
# standard IO errors get exposed directly.
124
self._open(filename, 'rb')
126
fcntl.lockf(self.f, fcntl.LOCK_SH)
128
# we should be more precise about whats a locking
129
# error and whats a random-other error
136
WriteLock = _fcntl_WriteLock
137
ReadLock = _fcntl_ReadLock
51
LOCK_SH = fcntl.LOCK_SH
52
LOCK_EX = fcntl.LOCK_EX
53
LOCK_NB = fcntl.LOCK_NB
62
fcntl.flock(f, fcntl.LOCK_UN)
140
66
except ImportError:
142
68
import win32con, win32file, pywintypes
145
69
LOCK_SH = 0 # the default
146
70
LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
147
71
LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
149
class _w32c_FileLock(_base_Lock):
150
def _lock(self, filename, openmode, lockmode):
152
self._open(filename, openmode)
153
self.hfile = win32file._get_osfhandle(self.f.fileno())
154
overlapped = pywintypes.OVERLAPPED()
155
win32file.LockFileEx(self.hfile, lockmode, 0, 0x7fff0000, overlapped)
164
overlapped = pywintypes.OVERLAPPED()
165
win32file.UnlockFileEx(self.hfile, 0, 0x7fff0000, overlapped)
172
class _w32c_ReadLock(_w32c_FileLock):
173
def __init__(self, filename):
174
_w32c_FileLock._lock(self, filename, 'rb',
177
class _w32c_WriteLock(_w32c_FileLock):
178
def __init__(self, filename):
179
_w32c_FileLock._lock(self, filename, 'wb',
183
WriteLock = _w32c_WriteLock
184
ReadLock = _w32c_ReadLock
76
hfile = win32file._get_osfhandle(f.fileno())
78
hfile = win32file._get_osfhandle(f)
79
overlapped = pywintypes.OVERLAPPED()
80
win32file.LockFileEx(hfile, flags, 0, 0x7fff0000, overlapped)
87
hfile = win32file._get_osfhandle(f.fileno())
89
hfile = win32file._get_osfhandle(f)
90
overlapped = pywintypes.OVERLAPPED()
91
win32file.UnlockFileEx(hfile, 0, 0x7fff0000, overlapped)
186
94
except ImportError:
191
97
# Unfortunately, msvcrt.locking() doesn't distinguish between
192
98
# read locks and write locks. Also, the way the combinations
193
99
# work to get non-blocking is not the same, so we
194
100
# have to write extra special functions here.
197
class _msvc_FileLock(_base_Lock):
207
class _msvc_ReadLock(_msvc_FileLock):
208
def __init__(self, filename):
209
_msvc_lock(self._open(filename, 'rb'), self.LOCK_SH)
212
class _msvc_WriteLock(_msvc_FileLock):
213
def __init__(self, filename):
214
_msvc_lock(self._open(filename, 'wb'), self.LOCK_EX)
217
def _msvc_lock(f, flags):
219
108
# Unfortunately, msvcrt.LK_RLCK is equivalent to msvcrt.LK_LOCK
220
109
# according to the comments, LK_RLCK is open the lock for writing.
added
removed
bzrlib/lock.py
