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 (
116
from bzrlib.trace import mutter
117
from bzrlib.transport import Transport
118
from bzrlib.osutils import rand_chars
119
from bzrlib.rio import RioWriter, read_stanza, Stanza
121
# XXX: At the moment there is no consideration of thread safety on LockDir
122
# objects. This should perhaps be updated - e.g. if two threads try to take a
123
# lock at the same time they should *both* get it. But then that's unlikely
126
# TODO: Transport could offer a simpler put() method that avoids the
127
# rename-into-place for cases like creating the lock template, where there is
128
# no chance that the file already exists.
130
# TODO: Perhaps store some kind of note like the bzr command line in the lock
133
# TODO: Some kind of callback run while polling a lock to show progress
136
# TODO: Make sure to pass the right file and directory mode bits to all
137
# files/dirs created.
139
_DEFAULT_TIMEOUT_SECONDS = 300
140
_DEFAULT_POLL_SECONDS = 0.5
142
class LockDir(object):
143
"""Write-lock guarding access to data."""
145
__INFO_NAME = '/info'
147
def __init__(self, transport, path, file_modebits=0644, dir_modebits=0755):
148
"""Create a new LockDir object.
150
The LockDir is initially unlocked - this just creates the object.
152
:param transport: Transport which will contain the lock
154
:param path: Path to the lock within the base directory of the
157
assert isinstance(transport, Transport), \
158
("not a transport: %r" % transport)
159
self.transport = transport
161
self._lock_held = False
162
self._fake_read_lock = False
163
self._held_dir = path + '/held'
164
self._held_info_path = self._held_dir + self.__INFO_NAME
165
self._file_modebits = file_modebits
166
self._dir_modebits = dir_modebits
167
self.nonce = rand_chars(20)
170
return '%s(%s%s)' % (self.__class__.__name__,
174
is_held = property(lambda self: self._lock_held)
176
def create(self, mode=None):
177
"""Create the on-disk lock.
179
This is typically only called when the object/directory containing the
180
directory is first created. The lock is not held when it's created.
182
if self.transport.is_readonly():
183
raise UnlockableTransport(self.transport)
184
self.transport.mkdir(self.path, mode=mode)
186
def attempt_lock(self):
187
"""Take the lock; fail if it's already held.
189
If you wish to block until the lock can be obtained, call wait_lock()
192
if self._fake_read_lock:
193
raise LockContention(self)
194
if self.transport.is_readonly():
195
raise UnlockableTransport(self.transport)
197
tmpname = '%s/pending.%s.tmp' % (self.path, rand_chars(20))
198
self.transport.mkdir(tmpname)
200
self._prepare_info(sio)
202
self.transport.put(tmpname + self.__INFO_NAME, sio)
203
self.transport.rename(tmpname, self._held_dir)
204
self._lock_held = True
206
except (PathError, DirectoryNotEmpty, FileExists, ResourceBusy), e:
207
mutter("contention on %r: %s", self, e)
208
raise LockContention(self)
211
"""Release a held lock
213
if self._fake_read_lock:
214
self._fake_read_lock = False
216
if not self._lock_held:
217
raise LockNotHeld(self)
218
# rename before deleting, because we can't atomically remove the whole
220
tmpname = '%s/releasing.%s.tmp' % (self.path, rand_chars(20))
221
# gotta own it to unlock
223
self.transport.rename(self._held_dir, tmpname)
224
self._lock_held = False
225
self.transport.delete(tmpname + self.__INFO_NAME)
226
self.transport.rmdir(tmpname)
228
def break_lock(self):
229
"""Break a lock not held by this instance of LockDir.
231
This is a UI centric function: it uses the bzrlib.ui.ui_factory to
232
prompt for input if a lock is detected and there is any doubt about
233
it possibly being still active.
235
self._check_not_locked()
236
holder_info = self.peek()
237
if holder_info is not None:
238
if bzrlib.ui.ui_factory.get_boolean(
239
"Break lock %s held by %s@%s" % (
242
holder_info["hostname"])):
243
self.force_break(holder_info)
245
def force_break(self, dead_holder_info):
246
"""Release a lock held by another process.
248
WARNING: This should only be used when the other process is dead; if
249
it still thinks it has the lock there will be two concurrent writers.
250
In general the user's approval should be sought for lock breaks.
252
dead_holder_info must be the result of a previous LockDir.peek() call;
253
this is used to check that it's still held by the same process that
254
the user decided was dead. If this is not the current holder,
255
LockBreakMismatch is raised.
257
After the lock is broken it will not be held by any process.
258
It is possible that another process may sneak in and take the
259
lock before the breaking process acquires it.
261
if not isinstance(dead_holder_info, dict):
262
raise ValueError("dead_holder_info: %r" % dead_holder_info)
263
self._check_not_locked()
264
current_info = self.peek()
265
if current_info is None:
266
# must have been recently released
268
if current_info != dead_holder_info:
269
raise LockBreakMismatch(self, current_info, dead_holder_info)
270
tmpname = '%s/broken.%s.tmp' % (self.path, rand_chars(20))
271
self.transport.rename(self._held_dir, tmpname)
272
# check that we actually broke the right lock, not someone else;
273
# there's a small race window between checking it and doing the
275
broken_info_path = tmpname + self.__INFO_NAME
276
broken_info = self._read_info_file(broken_info_path)
277
if broken_info != dead_holder_info:
278
raise LockBreakMismatch(self, broken_info, dead_holder_info)
279
self.transport.delete(broken_info_path)
280
self.transport.rmdir(tmpname)
282
def _check_not_locked(self):
283
"""If the lock is held by this instance, raise an error."""
285
raise AssertionError("can't break own lock: %r" % self)
288
"""Make sure that the lock is still held by this locker.
290
This should only fail if the lock was broken by user intervention,
291
or if the lock has been affected by a bug.
293
If the lock is not thought to be held, raises LockNotHeld. If
294
the lock is thought to be held but has been broken, raises
297
if not self._lock_held:
298
raise LockNotHeld(self)
301
# no lock there anymore!
302
raise LockBroken(self)
303
if info.get('nonce') != self.nonce:
304
# there is a lock, but not ours
305
raise LockBroken(self)
307
def _read_info_file(self, path):
308
"""Read one given info file.
310
peek() reads the info file of the lock holder, if any.
312
return self._parse_info(self.transport.get(path))
315
"""Check if the lock is held by anyone.
317
If it is held, this returns the lock info structure as a rio Stanza,
318
which contains some information about the current lock holder.
319
Otherwise returns None.
322
info = self._read_info_file(self._held_info_path)
323
assert isinstance(info, dict), \
324
"bad parse result %r" % info
326
except NoSuchFile, e:
329
def _prepare_info(self, outf):
330
"""Write information about a pending lock to a temporary file.
333
# XXX: is creating this here inefficient?
334
config = bzrlib.config.GlobalConfig()
335
s = Stanza(hostname=socket.gethostname(),
336
pid=str(os.getpid()),
337
start_time=str(int(time.time())),
339
user=config.user_email(),
341
RioWriter(outf).write_stanza(s)
343
def _parse_info(self, info_file):
344
return read_stanza(info_file.readlines()).as_dict()
346
def wait_lock(self, timeout=_DEFAULT_TIMEOUT_SECONDS,
347
poll=_DEFAULT_POLL_SECONDS):
348
"""Wait a certain period for a lock.
350
If the lock can be acquired within the bounded time, it
351
is taken and this returns. Otherwise, LockContention
352
is raised. Either way, this function should return within
353
approximately `timeout` seconds. (It may be a bit more if
354
a transport operation takes a long time to complete.)
356
# XXX: the transport interface doesn't let us guard
357
# against operations there taking a long time.
358
deadline = time.time() + timeout
363
except LockContention:
365
if time.time() + poll < deadline:
368
raise LockContention(self)
370
def lock_write(self):
371
"""Wait for and acquire the lock."""
375
"""Compatability-mode shared lock.
377
LockDir doesn't support shared read-only locks, so this
378
just pretends that the lock is taken but really does nothing.
380
# At the moment Branches are commonly locked for read, but
381
# we can't rely on that remotely. Once this is cleaned up,
382
# reenable this warning to prevent it coming back in
384
## warn("LockDir.lock_read falls back to write lock")
385
if self._lock_held or self._fake_read_lock:
386
raise LockContention(self)
387
self._fake_read_lock = True
389
def wait(self, timeout=20, poll=0.5):
390
"""Wait a certain period for a lock to be released."""
391
# XXX: the transport interface doesn't let us guard
392
# against operations there taking a long time.
393
deadline = time.time() + timeout
397
if time.time() + poll < deadline:
400
raise LockContention(self)
added
removed
bzrlib/lockdir.py
