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
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.
32
32
This defines two classes: ReadLock and WriteLock, which can be
33
33
implemented in different ways on different platforms. Both have an
41
from bzrlib.trace import mutter, note, warning
42
from bzrlib.errors import LockError
40
from trace import mutter, note, warning
41
from errors import LockError
44
43
class _base_Lock(object):
45
44
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+')
45
self.f = open(filename, filemode)
61
51
from warnings import warn
62
52
warn("lock on %r not released" % self.f)
66
56
raise NotImplementedError()
84
fcntl.lockf(self.f, fcntl.LOCK_UN)
74
fcntl.flock(self.f, fcntl.LOCK_UN)
88
79
class _fcntl_WriteLock(_fcntl_FileLock):
89
80
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
82
fcntl.flock(self._open(filename, 'wb'), fcntl.LOCK_EX)
99
87
class _fcntl_ReadLock(_fcntl_FileLock):
101
88
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
90
fcntl.flock(self._open(filename, 'rb'), fcntl.LOCK_SH)
109
92
raise LockError(e)
111
94
WriteLock = _fcntl_WriteLock
112
95
ReadLock = _fcntl_ReadLock
115
97
except ImportError:
117
99
import win32con, win32file, pywintypes
120
LOCK_SH = 0 # the default
121
LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
122
LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
102
#LOCK_SH = 0 # the default
103
#LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
104
#LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
124
106
class _w32c_FileLock(_base_Lock):
125
107
def _lock(self, filename, openmode, lockmode):
145
127
class _w32c_ReadLock(_w32c_FileLock):
146
128
def __init__(self, filename):
147
_w32c_FileLock._lock(self, filename, 'rb',
129
_w32c_FileLock._lock(self, filename, 'rb', 0)
150
131
class _w32c_WriteLock(_w32c_FileLock):
151
132
def __init__(self, filename):
152
133
_w32c_FileLock._lock(self, filename, 'wb',
134
win32con.LOCKFILE_EXCLUSIVE_LOCK)
206
185
fpos = os.lseek(fn, 0,0)
207
186
os.lseek(fn, 0,0)
209
if flags & _msvc_FileLock.LOCK_SH:
210
if flags & _msvc_FileLock.LOCK_NB:
188
if flags & self.LOCK_SH:
189
if flags & self.LOCK_NB:
211
190
lock_mode = msvcrt.LK_NBLCK
213
192
lock_mode = msvcrt.LK_LOCK
214
elif flags & _msvc_FileLock.LOCK_EX:
215
if flags & _msvc_FileLock.LOCK_NB:
193
elif flags & self.LOCK_EX:
194
if flags & self.LOCK_NB:
216
195
lock_mode = msvcrt.LK_NBRLCK
218
197
lock_mode = msvcrt.LK_RLCK