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
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.errors import LockError, LockContention
42
from bzrlib.osutils import realpath
43
from bzrlib.trace import mutter
41
from bzrlib.trace import mutter, note, warning
42
from bzrlib.errors import LockError
46
44
class _base_Lock(object):
48
45
def _open(self, filename, filemode):
50
48
self.f = open(filename, filemode)
56
54
# maybe this is an old branch (before may 2005)
57
mutter("trying to create missing branch lock %r", filename)
55
mutter("trying to create missing branch lock %r" % filename)
59
self.f = open(filename, 'wb+')
57
self.f = open(filename, 'wb')
64
63
from warnings import warn
65
64
warn("lock on %r not released" % self.f)
69
69
raise NotImplementedError()
72
76
############################################################
79
83
class _fcntl_FileLock(_base_Lock):
84
fcntl.lockf(self.f, fcntl.LOCK_UN)
88
"""Clear the self.f attribute cleanly."""
87
fcntl.flock(self.f, fcntl.LOCK_UN)
93
92
class _fcntl_WriteLock(_fcntl_FileLock):
97
93
def __init__(self, filename):
98
# standard IO errors get exposed directly.
99
self._open(filename, 'rb+')
100
self.filename = realpath(filename)
101
if self.filename in self.open_locks:
103
raise LockContention("Lock already held.")
104
# reserve a slot for this lock - even if the lockf call fails,
105
# at thisi point unlock() will be called, because self.f is set.
106
# TODO: make this fully threadsafe, if we decide we care.
107
self.open_locks[self.filename] = self.filename
109
# LOCK_NB will cause IOError to be raised if we can't grab a
111
fcntl.lockf(self.f, fcntl.LOCK_EX | fcntl.LOCK_NB)
113
if e.errno in (errno.EAGAIN, errno.EACCES):
114
# We couldn't grab the lock
116
# we should be more precise about whats a locking
117
# error and whats a random-other error
95
fcntl.flock(self._open(filename, 'wb'), fcntl.LOCK_EX)
118
97
raise LockError(e)
121
del self.open_locks[self.filename]
125
100
class _fcntl_ReadLock(_fcntl_FileLock):
127
101
def __init__(self, filename):
128
# standard IO errors get exposed directly.
129
self._open(filename, 'rb')
131
# LOCK_NB will cause IOError to be raised if we can't grab a
133
fcntl.lockf(self.f, fcntl.LOCK_SH | fcntl.LOCK_NB)
135
# we should be more precise about whats a locking
136
# error and whats a random-other error
103
fcntl.flock(self._open(filename, 'rb'), fcntl.LOCK_SH)
137
105
raise LockError(e)
143
107
WriteLock = _fcntl_WriteLock
144
108
ReadLock = _fcntl_ReadLock
147
110
except ImportError:
149
112
import win32con, win32file, pywintypes
152
LOCK_SH = 0 # the default
153
LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
154
LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
115
#LOCK_SH = 0 # the default
116
#LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK
117
#LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY
156
119
class _w32c_FileLock(_base_Lock):
157
120
def _lock(self, filename, openmode, lockmode):
176
136
raise LockError(e)
179
140
class _w32c_ReadLock(_w32c_FileLock):
180
141
def __init__(self, filename):
181
_w32c_FileLock._lock(self, filename, 'rb',
142
_w32c_FileLock._lock(self, filename, 'rb', 0)
184
144
class _w32c_WriteLock(_w32c_FileLock):
185
145
def __init__(self, filename):
186
_w32c_FileLock._lock(self, filename, 'rb+',
146
_w32c_FileLock._lock(self, filename, 'wb',
147
win32con.LOCKFILE_EXCLUSIVE_LOCK)
190
151
WriteLock = _w32c_WriteLock
209
169
def unlock(self):
210
170
_msvc_unlock(self.f)
215
173
class _msvc_ReadLock(_msvc_FileLock):
216
174
def __init__(self, filename):
217
_msvc_lock(self._open(filename, 'rb'),
218
self.LOCK_SH | self.LOCK_NB)
175
_msvc_lock(self._open(filename, 'rb'), self.LOCK_SH)
221
178
class _msvc_WriteLock(_msvc_FileLock):
222
179
def __init__(self, filename):
223
_msvc_lock(self._open(filename, 'rb+'),
224
self.LOCK_EX | self.LOCK_NB)
180
_msvc_lock(self._open(filename, 'wb'), self.LOCK_EX)
227
184
def _msvc_lock(f, flags):
added
removed
bzrlib/lock.py
