1
# Copyright (C) 2006, 2007, 2008 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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')
91
>>> token = l.wait_lock()
92
>>> # do something here
98
# TODO: We sometimes have the problem that our attempt to rename '1234' to
99
# 'held' fails because the transport server moves into an existing directory,
100
# rather than failing the rename. If we made the info file name the same as
101
# the locked directory name we would avoid this problem because moving into
102
# the held directory would implicitly clash. However this would not mesh with
103
# the existing locking code and needs a new format of the containing object.
104
# -- robertc, mbp 20070628
115
from bzrlib.errors import (
128
from bzrlib.trace import mutter, note
129
from bzrlib.osutils import format_delta, rand_chars, get_host_name
132
from bzrlib.lazy_import import lazy_import
133
lazy_import(globals(), """
134
from bzrlib import rio
137
# XXX: At the moment there is no consideration of thread safety on LockDir
138
# objects. This should perhaps be updated - e.g. if two threads try to take a
139
# lock at the same time they should *both* get it. But then that's unlikely
142
# TODO: Perhaps store some kind of note like the bzr command line in the lock
145
# TODO: Some kind of callback run while polling a lock to show progress
148
# TODO: Make sure to pass the right file and directory mode bits to all
149
# files/dirs created.
152
_DEFAULT_TIMEOUT_SECONDS = 300
153
_DEFAULT_POLL_SECONDS = 1.0
156
class LockDir(lock.Lock):
157
"""Write-lock guarding access to data.
160
__INFO_NAME = '/info'
162
def __init__(self, transport, path, file_modebits=0644, dir_modebits=0755):
163
"""Create a new LockDir object.
165
The LockDir is initially unlocked - this just creates the object.
167
:param transport: Transport which will contain the lock
169
:param path: Path to the lock within the base directory of the
172
self.transport = transport
174
self._lock_held = False
175
self._locked_via_token = False
176
self._fake_read_lock = False
177
self._held_dir = path + '/held'
178
self._held_info_path = self._held_dir + self.__INFO_NAME
179
self._file_modebits = file_modebits
180
self._dir_modebits = dir_modebits
182
self._report_function = note
185
return '%s(%s%s)' % (self.__class__.__name__,
189
is_held = property(lambda self: self._lock_held)
191
def create(self, mode=None):
192
"""Create the on-disk lock.
194
This is typically only called when the object/directory containing the
195
directory is first created. The lock is not held when it's created.
197
self._trace("create lock directory")
199
self.transport.mkdir(self.path, mode=mode)
200
except (TransportError, PathError), e:
201
raise LockFailed(self, e)
204
def _attempt_lock(self):
205
"""Make the pending directory and attempt to rename into place.
207
If the rename succeeds, we read back the info file to check that we
210
If we fail to acquire the lock, this method is responsible for
211
cleaning up the pending directory if possible. (But it doesn't do
214
:returns: The nonce of the lock, if it was successfully acquired.
216
:raises LockContention: If the lock is held by someone else. The exception
217
contains the info of the current holder of the lock.
219
self._trace("lock_write...")
220
start_time = time.time()
222
tmpname = self._create_pending_dir()
223
except (errors.TransportError, PathError), e:
224
self._trace("... failed to create pending dir, %s", e)
225
raise LockFailed(self, e)
227
self.transport.rename(tmpname, self._held_dir)
228
except (errors.TransportError, PathError, DirectoryNotEmpty,
229
FileExists, ResourceBusy), e:
230
self._trace("... contention, %s", e)
231
self._remove_pending_dir(tmpname)
232
raise LockContention(self)
234
self._trace("... lock failed, %s", e)
235
self._remove_pending_dir(tmpname)
237
# We must check we really got the lock, because Launchpad's sftp
238
# server at one time had a bug were the rename would successfully
239
# move the new directory into the existing directory, which was
240
# incorrect. It's possible some other servers or filesystems will
241
# have a similar bug allowing someone to think they got the lock
242
# when it's already held.
244
self._trace("after locking, info=%r", info)
245
if info['nonce'] != self.nonce:
246
self._trace("rename succeeded, "
247
"but lock is still held by someone else")
248
raise LockContention(self)
249
self._lock_held = True
250
self._trace("... lock succeeded after %dms",
251
(time.time() - start_time) * 1000)
254
def _remove_pending_dir(self, tmpname):
255
"""Remove the pending directory
257
This is called if we failed to rename into place, so that the pending
258
dirs don't clutter up the lockdir.
260
self._trace("remove %s", tmpname)
262
self.transport.delete(tmpname + self.__INFO_NAME)
263
self.transport.rmdir(tmpname)
265
note("error removing pending lock: %s", e)
267
def _create_pending_dir(self):
268
tmpname = '%s/%s.tmp' % (self.path, rand_chars(10))
270
self.transport.mkdir(tmpname)
272
# This may raise a FileExists exception
273
# which is okay, it will be caught later and determined
274
# to be a LockContention.
275
self._trace("lock directory does not exist, creating it")
276
self.create(mode=self._dir_modebits)
277
# After creating the lock directory, try again
278
self.transport.mkdir(tmpname)
279
self.nonce = rand_chars(20)
280
info_bytes = self._prepare_info()
281
# We use put_file_non_atomic because we just created a new unique
282
# directory so we don't have to worry about files existing there.
283
# We'll rename the whole directory into place to get atomic
285
self.transport.put_bytes_non_atomic(tmpname + self.__INFO_NAME,
290
"""Release a held lock
292
if self._fake_read_lock:
293
self._fake_read_lock = False
295
if not self._lock_held:
296
raise LockNotHeld(self)
297
if self._locked_via_token:
298
self._locked_via_token = False
299
self._lock_held = False
301
old_nonce = self.nonce
302
# rename before deleting, because we can't atomically remove the
304
start_time = time.time()
305
self._trace("unlocking")
306
tmpname = '%s/releasing.%s.tmp' % (self.path, rand_chars(20))
307
# gotta own it to unlock
309
self.transport.rename(self._held_dir, tmpname)
310
self._lock_held = False
311
self.transport.delete(tmpname + self.__INFO_NAME)
313
self.transport.rmdir(tmpname)
314
except DirectoryNotEmpty, e:
315
# There might have been junk left over by a rename that moved
316
# another locker within the 'held' directory. do a slower
317
# deletion where we list the directory and remove everything
320
# Maybe this should be broader to allow for ftp servers with
321
# non-specific error messages?
322
self._trace("doing recursive deletion of non-empty directory "
324
self.transport.delete_tree(tmpname)
325
self._trace("... unlock succeeded after %dms",
326
(time.time() - start_time) * 1000)
327
result = lock.LockResult(self.transport.abspath(self.path),
329
for hook in self.hooks['lock_released']:
332
def break_lock(self):
333
"""Break a lock not held by this instance of LockDir.
335
This is a UI centric function: it uses the bzrlib.ui.ui_factory to
336
prompt for input if a lock is detected and there is any doubt about
337
it possibly being still active.
339
self._check_not_locked()
340
holder_info = self.peek()
341
if holder_info is not None:
342
lock_info = '\n'.join(self._format_lock_info(holder_info))
343
if bzrlib.ui.ui_factory.get_boolean("Break %s" % lock_info):
344
self.force_break(holder_info)
346
def force_break(self, dead_holder_info):
347
"""Release a lock held by another process.
349
WARNING: This should only be used when the other process is dead; if
350
it still thinks it has the lock there will be two concurrent writers.
351
In general the user's approval should be sought for lock breaks.
353
dead_holder_info must be the result of a previous LockDir.peek() call;
354
this is used to check that it's still held by the same process that
355
the user decided was dead. If this is not the current holder,
356
LockBreakMismatch is raised.
358
After the lock is broken it will not be held by any process.
359
It is possible that another process may sneak in and take the
360
lock before the breaking process acquires it.
362
if not isinstance(dead_holder_info, dict):
363
raise ValueError("dead_holder_info: %r" % dead_holder_info)
364
self._check_not_locked()
365
current_info = self.peek()
366
if current_info is None:
367
# must have been recently released
369
if current_info != dead_holder_info:
370
raise LockBreakMismatch(self, current_info, dead_holder_info)
371
tmpname = '%s/broken.%s.tmp' % (self.path, rand_chars(20))
372
self.transport.rename(self._held_dir, tmpname)
373
# check that we actually broke the right lock, not someone else;
374
# there's a small race window between checking it and doing the
376
broken_info_path = tmpname + self.__INFO_NAME
377
broken_info = self._read_info_file(broken_info_path)
378
if broken_info != dead_holder_info:
379
raise LockBreakMismatch(self, broken_info, dead_holder_info)
380
self.transport.delete(broken_info_path)
381
self.transport.rmdir(tmpname)
382
result = lock.LockResult(self.transport.abspath(self.path),
383
current_info.get('nonce'))
384
for hook in self.hooks['lock_broken']:
387
def _check_not_locked(self):
388
"""If the lock is held by this instance, raise an error."""
390
raise AssertionError("can't break own lock: %r" % self)
393
"""Make sure that the lock is still held by this locker.
395
This should only fail if the lock was broken by user intervention,
396
or if the lock has been affected by a bug.
398
If the lock is not thought to be held, raises LockNotHeld. If
399
the lock is thought to be held but has been broken, raises
402
if not self._lock_held:
403
raise LockNotHeld(self)
406
# no lock there anymore!
407
raise LockBroken(self)
408
if info.get('nonce') != self.nonce:
409
# there is a lock, but not ours
410
raise LockBroken(self)
412
def _read_info_file(self, path):
413
"""Read one given info file.
415
peek() reads the info file of the lock holder, if any.
417
return self._parse_info(self.transport.get(path))
420
"""Check if the lock is held by anyone.
422
If it is held, this returns the lock info structure as a rio Stanza,
423
which contains some information about the current lock holder.
424
Otherwise returns None.
427
info = self._read_info_file(self._held_info_path)
428
self._trace("peek -> held")
430
except NoSuchFile, e:
431
self._trace("peek -> not held")
433
def _prepare_info(self):
434
"""Write information about a pending lock to a temporary file.
436
# XXX: is creating this here inefficient?
437
config = bzrlib.config.GlobalConfig()
439
user = config.user_email()
440
except errors.NoEmailInUsername:
441
user = config.username()
442
s = rio.Stanza(hostname=get_host_name(),
443
pid=str(os.getpid()),
444
start_time=str(int(time.time())),
450
def _parse_info(self, info_file):
451
return rio.read_stanza(info_file.readlines()).as_dict()
453
def attempt_lock(self):
454
"""Take the lock; fail if it's already held.
456
If you wish to block until the lock can be obtained, call wait_lock()
459
:return: The lock token.
460
:raises LockContention: if the lock is held by someone else.
462
if self._fake_read_lock:
463
raise LockContention(self)
464
result = self._attempt_lock()
465
hook_result = lock.LockResult(self.transport.abspath(self.path),
467
for hook in self.hooks['lock_acquired']:
471
def wait_lock(self, timeout=None, poll=None, max_attempts=None):
472
"""Wait a certain period for a lock.
474
If the lock can be acquired within the bounded time, it
475
is taken and this returns. Otherwise, LockContention
476
is raised. Either way, this function should return within
477
approximately `timeout` seconds. (It may be a bit more if
478
a transport operation takes a long time to complete.)
480
:param timeout: Approximate maximum amount of time to wait for the
483
:param poll: Delay in seconds between retrying the lock.
485
:param max_attempts: Maximum number of times to try to lock.
487
:return: The lock token.
490
timeout = _DEFAULT_TIMEOUT_SECONDS
492
poll = _DEFAULT_POLL_SECONDS
493
# XXX: the transport interface doesn't let us guard against operations
494
# there taking a long time, so the total elapsed time or poll interval
495
# may be more than was requested.
496
deadline = time.time() + timeout
503
return self.attempt_lock()
504
except LockContention:
505
# possibly report the blockage, then try again
507
# TODO: In a few cases, we find out that there's contention by
508
# reading the held info and observing that it's not ours. In
509
# those cases it's a bit redundant to read it again. However,
510
# the normal case (??) is that the rename fails and so we
511
# don't know who holds the lock. For simplicity we peek
513
new_info = self.peek()
514
if new_info is not None and new_info != last_info:
515
if last_info is None:
516
start = 'Unable to obtain'
518
start = 'Lock owner changed for'
520
formatted_info = self._format_lock_info(new_info)
521
if deadline_str is None:
522
deadline_str = time.strftime('%H:%M:%S',
523
time.localtime(deadline))
524
lock_url = self.transport.abspath(self.path)
525
self._report_function('%s %s\n'
527
'%s\n' # locked ... ago
528
'Will continue to try until %s, unless '
530
'If you\'re sure that it\'s not being '
531
'modified, use bzr break-lock %s',
539
if (max_attempts is not None) and (attempt_count >= max_attempts):
540
self._trace("exceeded %d attempts")
541
raise LockContention(self)
542
if time.time() + poll < deadline:
543
self._trace("waiting %ss", poll)
546
self._trace("timeout after waiting %ss", timeout)
547
raise LockContention(self)
549
def leave_in_place(self):
550
self._locked_via_token = True
552
def dont_leave_in_place(self):
553
self._locked_via_token = False
555
def lock_write(self, token=None):
556
"""Wait for and acquire the lock.
558
:param token: if this is already locked, then lock_write will fail
559
unless the token matches the existing lock.
560
:returns: a token if this instance supports tokens, otherwise None.
561
:raises TokenLockingNotSupported: when a token is given but this
562
instance doesn't support using token locks.
563
:raises MismatchedToken: if the specified token doesn't match the token
564
of the existing lock.
566
A token should be passed in if you know that you have locked the object
567
some other way, and need to synchronise this object's state with that
570
XXX: docstring duplicated from LockableFiles.lock_write.
572
if token is not None:
573
self.validate_token(token)
575
self._lock_held = True
576
self._locked_via_token = True
579
return self.wait_lock()
582
"""Compatibility-mode shared lock.
584
LockDir doesn't support shared read-only locks, so this
585
just pretends that the lock is taken but really does nothing.
587
# At the moment Branches are commonly locked for read, but
588
# we can't rely on that remotely. Once this is cleaned up,
589
# reenable this warning to prevent it coming back in
591
## warn("LockDir.lock_read falls back to write lock")
592
if self._lock_held or self._fake_read_lock:
593
raise LockContention(self)
594
self._fake_read_lock = True
596
def _format_lock_info(self, info):
597
"""Turn the contents of peek() into something for the user"""
598
lock_url = self.transport.abspath(self.path)
599
delta = time.time() - int(info['start_time'])
601
'lock %s' % (lock_url,),
602
'held by %(user)s on host %(hostname)s [process #%(pid)s]' % info,
603
'locked %s' % (format_delta(delta),),
606
def validate_token(self, token):
607
if token is not None:
613
lock_token = info.get('nonce')
614
if token != lock_token:
615
raise errors.TokenMismatch(token, lock_token)
617
self._trace("revalidated by token %r", token)
619
def _trace(self, format, *args):
620
if 'lock' not in debug.debug_flags:
622
mutter(str(self) + ": " + (format % args))
added
removed
bzrlib/lockdir.py
