1
# Copyright (C) 2005, 2006 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
41
from bzrlib.trace import mutter
42
from bzrlib.errors import LockError
44
class _base_Lock(object):
45
def _open(self, filename, filemode):
47
self.f = open(filename, filemode)
50
if e.errno != errno.ENOENT:
53
# maybe this is an old branch (before may 2005)
54
mutter("trying to create missing branch lock %r", filename)
56
self.f = open(filename, 'wb+')
61
from warnings import warn
62
warn("lock on %r not released" % self.f)
66
raise NotImplementedError()
73
############################################################
80
class _fcntl_FileLock(_base_Lock):
84
fcntl.lockf(self.f, fcntl.LOCK_UN)
88
class _fcntl_WriteLock(_fcntl_FileLock):
89
def __init__(self, filename):
90
# standard IO errors get exposed directly.
91
self._open(filename, 'wb')
93
fcntl.lockf(self.f, fcntl.LOCK_EX)
95
# we should be more precise about whats a locking
96
# error and whats a random-other error
99
class _fcntl_ReadLock(_fcntl_FileLock):
101
def __init__(self, filename):
102
# standard IO errors get exposed directly.
103
self._open(filename, 'rb')
105
fcntl.lockf(self.f, fcntl.LOCK_SH)
107
# we should be more precise about whats a locking
108
# error and whats a random-other error
111
WriteLock = _fcntl_WriteLock
112
ReadLock = _fcntl_ReadLock
117
import win32con, win32file, pywintypes
120
LOCK_SH = 0 # the default
121
LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
122
LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
124
class _w32c_FileLock(_base_Lock):
125
def _lock(self, filename, openmode, lockmode):
127
self._open(filename, openmode)
128
self.hfile = win32file._get_osfhandle(self.f.fileno())
129
overlapped = pywintypes.OVERLAPPED()
130
win32file.LockFileEx(self.hfile, lockmode, 0, 0x7fff0000, overlapped)
139
overlapped = pywintypes.OVERLAPPED()
140
win32file.UnlockFileEx(self.hfile, 0, 0x7fff0000, overlapped)
148
class _w32c_ReadLock(_w32c_FileLock):
149
def __init__(self, filename):
150
_w32c_FileLock._lock(self, filename, 'rb',
153
class _w32c_WriteLock(_w32c_FileLock):
154
def __init__(self, filename):
155
_w32c_FileLock._lock(self, filename, 'wb',
160
WriteLock = _w32c_WriteLock
161
ReadLock = _w32c_ReadLock
168
# Unfortunately, msvcrt.locking() doesn't distinguish between
169
# read locks and write locks. Also, the way the combinations
170
# work to get non-blocking is not the same, so we
171
# have to write extra special functions here.
174
class _msvc_FileLock(_base_Lock):
184
class _msvc_ReadLock(_msvc_FileLock):
185
def __init__(self, filename):
186
_msvc_lock(self._open(filename, 'rb'), self.LOCK_SH)
189
class _msvc_WriteLock(_msvc_FileLock):
190
def __init__(self, filename):
191
_msvc_lock(self._open(filename, 'wb'), self.LOCK_EX)
195
def _msvc_lock(f, flags):
197
# Unfortunately, msvcrt.LK_RLCK is equivalent to msvcrt.LK_LOCK
198
# according to the comments, LK_RLCK is open the lock for writing.
200
# Unfortunately, msvcrt.locking() also has the side effect that it
201
# will only block for 10 seconds at most, and then it will throw an
202
# exception, this isn't terrible, though.
209
fpos = os.lseek(fn, 0,0)
212
if flags & _msvc_FileLock.LOCK_SH:
213
if flags & _msvc_FileLock.LOCK_NB:
214
lock_mode = msvcrt.LK_NBLCK
216
lock_mode = msvcrt.LK_LOCK
217
elif flags & _msvc_FileLock.LOCK_EX:
218
if flags & _msvc_FileLock.LOCK_NB:
219
lock_mode = msvcrt.LK_NBRLCK
221
lock_mode = msvcrt.LK_RLCK
223
raise ValueError('Invalid lock mode: %r' % flags)
225
msvcrt.locking(fn, lock_mode, -1)
227
os.lseek(fn, fpos, 0)
239
fpos = os.lseek(fn, 0,0)
243
msvcrt.locking(fn, msvcrt.LK_UNLCK, -1)
245
os.lseek(fn, fpos, 0)
251
WriteLock = _msvc_WriteLock
252
ReadLock = _msvc_ReadLock
254
raise NotImplementedError("please write a locking method "
255
"for platform %r" % sys.platform)
added
removed
bzrlib/lock.py
