1
# Copyright (C) 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
17
"""On-disk mutex protecting a resource
19
bzr on-disk objects are locked by the existence of a directory with a
20
particular name within the control directory. We use this rather than OS
21
internal locks (such as flock etc) because they can be seen across all
22
transports, including http.
24
Objects can be read if there is only physical read access; therefore
25
readers can never be required to create a lock, though they will
26
check whether a writer is using the lock. Writers can't detect
27
whether anyone else is reading from the resource as they write.
28
This works because of ordering constraints that make sure readers
29
see a consistent view of existing data.
31
Waiting for a lock must be done by polling; this can be aborted after
34
Locks must always be explicitly released, typically from a try/finally
35
block -- they are not released from a finalizer or when Python
38
Locks may fail to be released if the process is abruptly terminated
39
(machine stop, SIGKILL) or if a remote transport becomes permanently
40
disconnected. There is therefore a method to break an existing lock.
41
This should rarely be used, and generally only with user approval.
42
Locks contain some information on when the lock was taken and by who
43
which may guide in deciding whether it can safely be broken. (This is
44
similar to the messages displayed by emacs and vim.) Note that if the
45
lock holder is still alive they will get no notification that the lock
46
has been broken and will continue their work -- so it is important to be
47
sure they are actually dead.
49
A lock is represented on disk by a directory of a particular name,
50
containing an information file. Taking a lock is done by renaming a
51
temporary directory into place. We use temporary directories because
52
for all known transports and filesystems we believe that exactly one
53
attempt to claim the lock will succeed and the others will fail. (Files
54
won't do because some filesystems or transports only have
55
rename-and-overwrite, making it hard to tell who won.)
57
The desired characteristics are:
59
* Locks are not reentrant. (That is, a client that tries to take a
60
lock it already holds may deadlock or fail.)
61
* Stale locks can be guessed at by a heuristic
62
* Lost locks can be broken by any client
63
* Failed lock operations leave little or no mess
64
* Deadlocks are avoided by having a timeout always in use, clients
65
desiring indefinite waits can retry or set a silly big timeout.
67
Storage formats use the locks, and also need to consider concurrency
68
issues underneath the lock. A format may choose not to use a lock
69
at all for some operations.
71
LockDirs always operate over a Transport. The transport may be readonly, in
72
which case the lock can be queried but not acquired.
74
Locks are identified by a path name, relative to a base transport.
76
Calling code will typically want to make sure there is exactly one LockDir
77
object per actual lock on disk. This module does nothing to prevent aliasing
78
and deadlocks will likely occur if the locks are aliased.
80
In the future we may add a "freshen" method which can be called
81
by a lock holder to check that their lock has not been broken, and to
82
update the timestamp within it.
86
>>> from bzrlib.transport.memory import MemoryTransport
87
>>> # typically will be obtained from a BzrDir, Branch, etc
88
>>> t = MemoryTransport()
89
>>> l = LockDir(t, 'sample-lock')
92
>>> # do something here
99
from warnings import warn
100
from StringIO import StringIO
103
from bzrlib.errors import (
114
from bzrlib.transport import Transport
115
from bzrlib.osutils import rand_chars
116
from bzrlib.rio import RioWriter, read_stanza, Stanza
118
# XXX: At the moment there is no consideration of thread safety on LockDir
119
# objects. This should perhaps be updated - e.g. if two threads try to take a
120
# lock at the same time they should *both* get it. But then that's unlikely
123
# TODO: Transport could offer a simpler put() method that avoids the
124
# rename-into-place for cases like creating the lock template, where there is
125
# no chance that the file already exists.
127
# TODO: Perhaps store some kind of note like the bzr command line in the lock
130
# TODO: Some kind of callback run while polling a lock to show progress
133
# TODO: Make sure to pass the right file and directory mode bits to all
134
# files/dirs created.
136
_DEFAULT_TIMEOUT_SECONDS = 300
137
_DEFAULT_POLL_SECONDS = 0.5
139
class LockDir(object):
140
"""Write-lock guarding access to data."""
142
__INFO_NAME = '/info'
144
def __init__(self, transport, path, file_modebits=0644, dir_modebits=0755):
145
"""Create a new LockDir object.
147
The LockDir is initially unlocked - this just creates the object.
149
:param transport: Transport which will contain the lock
151
:param path: Path to the lock within the base directory of the
154
assert isinstance(transport, Transport), \
155
("not a transport: %r" % transport)
156
self.transport = transport
158
self._lock_held = False
159
self._fake_read_lock = False
160
self._held_dir = path + '/held'
161
self._held_info_path = self._held_dir + self.__INFO_NAME
162
self._file_modebits = file_modebits
163
self._dir_modebits = dir_modebits
164
self.nonce = rand_chars(20)
167
return '%s(%s%s)' % (self.__class__.__name__,
171
is_held = property(lambda self: self._lock_held)
174
"""Create the on-disk lock.
176
This is typically only called when the object/directory containing the
177
directory is first created. The lock is not held when it's created.
179
if self.transport.is_readonly():
180
raise UnlockableTransport(self.transport)
181
self.transport.mkdir(self.path)
183
def attempt_lock(self):
184
"""Take the lock; fail if it's already held.
186
If you wish to block until the lock can be obtained, call wait_lock()
189
if self._fake_read_lock:
190
raise LockContention(self)
191
if self.transport.is_readonly():
192
raise UnlockableTransport(self.transport)
194
tmpname = '%s/pending.%s.tmp' % (self.path, rand_chars(20))
195
self.transport.mkdir(tmpname)
197
self._prepare_info(sio)
199
self.transport.put(tmpname + self.__INFO_NAME, sio)
200
self.transport.rename(tmpname, self._held_dir)
201
self._lock_held = True
204
except (DirectoryNotEmpty, FileExists), e:
206
# fall through to here on contention
207
raise LockContention(self)
210
"""Release a held lock
212
if self._fake_read_lock:
213
self._fake_read_lock = False
215
if not self._lock_held:
216
raise LockNotHeld(self)
217
# rename before deleting, because we can't atomically remove the whole
219
tmpname = '%s/releasing.%s.tmp' % (self.path, rand_chars(20))
220
self.transport.rename(self._held_dir, tmpname)
221
self._lock_held = False
222
self.transport.delete(tmpname + self.__INFO_NAME)
223
self.transport.rmdir(tmpname)
225
def force_break(self, dead_holder_info):
226
"""Release a lock held by another process.
228
WARNING: This should only be used when the other process is dead; if
229
it still thinks it has the lock there will be two concurrent writers.
230
In general the user's approval should be sought for lock breaks.
232
dead_holder_info must be the result of a previous LockDir.peek() call;
233
this is used to check that it's still held by the same process that
234
the user decided was dead. If this is not the current holder,
235
LockBreakMismatch is raised.
237
After the lock is broken it will not be held by any process.
238
It is possible that another process may sneak in and take the
239
lock before the breaking process acquires it.
241
if not isinstance(dead_holder_info, dict):
242
raise ValueError("dead_holder_info: %r" % dead_holder_info)
244
raise AssertionError("can't break own lock: %r" % self)
245
current_info = self.peek()
246
if current_info is None:
247
# must have been recently released
249
if current_info != dead_holder_info:
250
raise LockBreakMismatch(self, current_info, dead_holder_info)
251
tmpname = '%s/broken.%s.tmp' % (self.path, rand_chars(20))
252
self.transport.rename(self._held_dir, tmpname)
253
# check that we actually broke the right lock, not someone else;
254
# there's a small race window between checking it and doing the
256
broken_info_path = tmpname + self.__INFO_NAME
257
broken_info = self._read_info_file(broken_info_path)
258
if broken_info != dead_holder_info:
259
raise LockBreakMismatch(self, broken_info, dead_holder_info)
260
self.transport.delete(broken_info_path)
261
self.transport.rmdir(tmpname)
264
"""Make sure that the lock is still held by this locker.
266
This should only fail if the lock was broken by user intervention,
267
or if the lock has been affected by a bug.
269
If the lock is not thought to be held, raises LockNotHeld. If
270
the lock is thought to be held but has been broken, raises
273
if not self._lock_held:
274
raise LockNotHeld(self)
277
# no lock there anymore!
278
raise LockBroken(self)
279
if info.get('nonce') != self.nonce:
280
# there is a lock, but not ours
281
raise LockBroken(self)
283
def _read_info_file(self, path):
284
"""Read one given info file.
286
peek() reads the info file of the lock holder, if any.
288
return self._parse_info(self.transport.get(path))
291
"""Check if the lock is held by anyone.
293
If it is held, this returns the lock info structure as a rio Stanza,
294
which contains some information about the current lock holder.
295
Otherwise returns None.
298
info = self._read_info_file(self._held_info_path)
299
assert isinstance(info, dict), \
300
"bad parse result %r" % info
302
except NoSuchFile, e:
305
def _prepare_info(self, outf):
306
"""Write information about a pending lock to a temporary file.
309
# XXX: is creating this here inefficient?
310
config = bzrlib.config.GlobalConfig()
311
s = Stanza(hostname=socket.gethostname(),
312
pid=str(os.getpid()),
313
start_time=str(int(time.time())),
315
user=config.user_email(),
317
RioWriter(outf).write_stanza(s)
319
def _parse_info(self, info_file):
320
return read_stanza(info_file.readlines()).as_dict()
322
def wait_lock(self, timeout=_DEFAULT_TIMEOUT_SECONDS,
323
poll=_DEFAULT_POLL_SECONDS):
324
"""Wait a certain period for a lock.
326
If the lock can be acquired within the bounded time, it
327
is taken and this returns. Otherwise, LockContention
328
is raised. Either way, this function should return within
329
approximately `timeout` seconds. (It may be a bit more if
330
a transport operation takes a long time to complete.)
332
# XXX: the transport interface doesn't let us guard
333
# against operations there taking a long time.
334
deadline = time.time() + timeout
339
except LockContention:
341
if time.time() + poll < deadline:
344
raise LockContention(self)
346
def lock_write(self):
347
"""Wait for and acquire the lock."""
351
"""Compatability-mode shared lock.
353
LockDir doesn't support shared read-only locks, so this
354
just pretends that the lock is taken but really does nothing.
356
# At the moment Branches are commonly locked for read, but
357
# we can't rely on that remotely. Once this is cleaned up,
358
# reenable this warning to prevent it coming back in
360
## warn("LockDir.lock_read falls back to write lock")
361
if self._lock_held or self._fake_read_lock:
362
raise LockContention(self)
363
self._fake_read_lock = True
365
def wait(self, timeout=20, poll=0.5):
366
"""Wait a certain period for a lock to be released."""
367
# XXX: the transport interface doesn't let us guard
368
# against operations there taking a long time.
369
deadline = time.time() + timeout
373
if time.time() + poll < deadline:
376
raise LockContention(self)
added
removed
bzrlib/lockdir.py
