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
45
class _base_Lock(object):
46
def _open(self, filename, filemode):
48
self.f = open(filename, filemode)
51
if e.errno != errno.ENOENT:
54
# maybe this is an old branch (before may 2005)
55
mutter("trying to create missing branch lock %r", filename)
57
self.f = open(filename, 'wb+')
62
from warnings import warn
63
warn("lock on %r not released" % self.f)
67
raise NotImplementedError()
70
############################################################
77
class _fcntl_FileLock(_base_Lock):
81
fcntl.lockf(self.f, fcntl.LOCK_UN)
85
class _fcntl_WriteLock(_fcntl_FileLock):
86
def __init__(self, filename):
87
# standard IO errors get exposed directly.
88
self._open(filename, 'wb')
90
fcntl.lockf(self.f, fcntl.LOCK_EX)
92
# we should be more precise about whats a locking
93
# error and whats a random-other error
96
class _fcntl_ReadLock(_fcntl_FileLock):
98
def __init__(self, filename):
99
# standard IO errors get exposed directly.
100
self._open(filename, 'rb')
102
fcntl.lockf(self.f, fcntl.LOCK_SH)
104
# we should be more precise about whats a locking
105
# error and whats a random-other error
108
WriteLock = _fcntl_WriteLock
109
ReadLock = _fcntl_ReadLock
114
import win32con, win32file, pywintypes
117
LOCK_SH = 0 # the default
118
LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
119
LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
121
class _w32c_FileLock(_base_Lock):
122
def _lock(self, filename, openmode, lockmode):
124
self._open(filename, openmode)
125
self.hfile = win32file._get_osfhandle(self.f.fileno())
126
overlapped = pywintypes.OVERLAPPED()
127
win32file.LockFileEx(self.hfile, lockmode, 0, 0x7fff0000, overlapped)
136
overlapped = pywintypes.OVERLAPPED()
137
win32file.UnlockFileEx(self.hfile, 0, 0x7fff0000, overlapped)
144
class _w32c_ReadLock(_w32c_FileLock):
145
def __init__(self, filename):
146
_w32c_FileLock._lock(self, filename, 'rb',
149
class _w32c_WriteLock(_w32c_FileLock):
150
def __init__(self, filename):
151
_w32c_FileLock._lock(self, filename, 'wb',
155
WriteLock = _w32c_WriteLock
156
ReadLock = _w32c_ReadLock
163
# Unfortunately, msvcrt.locking() doesn't distinguish between
164
# read locks and write locks. Also, the way the combinations
165
# work to get non-blocking is not the same, so we
166
# have to write extra special functions here.
169
class _msvc_FileLock(_base_Lock):
179
class _msvc_ReadLock(_msvc_FileLock):
180
def __init__(self, filename):
181
_msvc_lock(self._open(filename, 'rb'), self.LOCK_SH)
184
class _msvc_WriteLock(_msvc_FileLock):
185
def __init__(self, filename):
186
_msvc_lock(self._open(filename, 'wb'), self.LOCK_EX)
189
def _msvc_lock(f, flags):
191
# Unfortunately, msvcrt.LK_RLCK is equivalent to msvcrt.LK_LOCK
192
# according to the comments, LK_RLCK is open the lock for writing.
194
# Unfortunately, msvcrt.locking() also has the side effect that it
195
# will only block for 10 seconds at most, and then it will throw an
196
# exception, this isn't terrible, though.
203
fpos = os.lseek(fn, 0,0)
206
if flags & _msvc_FileLock.LOCK_SH:
207
if flags & _msvc_FileLock.LOCK_NB:
208
lock_mode = msvcrt.LK_NBLCK
210
lock_mode = msvcrt.LK_LOCK
211
elif flags & _msvc_FileLock.LOCK_EX:
212
if flags & _msvc_FileLock.LOCK_NB:
213
lock_mode = msvcrt.LK_NBRLCK
215
lock_mode = msvcrt.LK_RLCK
217
raise ValueError('Invalid lock mode: %r' % flags)
219
msvcrt.locking(fn, lock_mode, -1)
221
os.lseek(fn, fpos, 0)
233
fpos = os.lseek(fn, 0,0)
237
msvcrt.locking(fn, msvcrt.LK_UNLCK, -1)
239
os.lseek(fn, fpos, 0)
244
WriteLock = _msvc_WriteLock
245
ReadLock = _msvc_ReadLock
247
raise NotImplementedError("please write a locking method "
248
"for platform %r" % sys.platform)
added
removed
bzrlib/lock.py
