1
# Copyright (C) 2006-2011 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 breezy.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
95
Some classes of stale locks can be predicted by checking: the host name is the
96
same as the local host name; the user name is the same as the local user; the
97
process id no longer exists. The check on user name is not strictly necessary
98
but helps protect against colliding host names.
101
from __future__ import absolute_import
104
# TODO: We sometimes have the problem that our attempt to rename '1234' to
105
# 'held' fails because the transport server moves into an existing directory,
106
# rather than failing the rename. If we made the info file name the same as
107
# the locked directory name we would avoid this problem because moving into
108
# the held directory would implicitly clash. However this would not mesh with
109
# the existing locking code and needs a new format of the containing object.
110
# -- robertc, mbp 20070628
124
from .decorators import only_raises
125
from .errors import (
139
from .i18n import gettext
140
from .osutils import format_delta, rand_chars, get_host_name
141
from .sixish import (
145
from .trace import mutter, note
147
from .lazy_import import lazy_import
148
lazy_import(globals(), """
149
from breezy import rio
152
# XXX: At the moment there is no consideration of thread safety on LockDir
153
# objects. This should perhaps be updated - e.g. if two threads try to take a
154
# lock at the same time they should *both* get it. But then that's unlikely
157
# TODO: Perhaps store some kind of note like the bzr command line in the lock
160
# TODO: Some kind of callback run while polling a lock to show progress
163
# TODO: Make sure to pass the right file and directory mode bits to all
164
# files/dirs created.
167
_DEFAULT_TIMEOUT_SECONDS = 30
168
_DEFAULT_POLL_SECONDS = 1.0
171
class LockDir(lock.Lock):
172
"""Write-lock guarding access to data.
175
__INFO_NAME = '/info'
177
def __init__(self, transport, path, file_modebits=0o644, dir_modebits=0o755,
178
extra_holder_info=None):
179
"""Create a new LockDir object.
181
The LockDir is initially unlocked - this just creates the object.
183
:param transport: Transport which will contain the lock
185
:param path: Path to the lock within the base directory of the
188
:param extra_holder_info: If passed, {str:str} dict of extra or
189
updated information to insert into the info file when the lock is
192
self.transport = transport
194
self._lock_held = False
195
self._locked_via_token = False
196
self._fake_read_lock = False
197
self._held_dir = path + '/held'
198
self._held_info_path = self._held_dir + self.__INFO_NAME
199
self._file_modebits = file_modebits
200
self._dir_modebits = dir_modebits
201
self._report_function = note
202
self.extra_holder_info = extra_holder_info
203
self._warned_about_lock_holder = None
206
return '%s(%s%s)' % (self.__class__.__name__,
210
is_held = property(lambda self: self._lock_held)
212
def create(self, mode=None):
213
"""Create the on-disk lock.
215
This is typically only called when the object/directory containing the
216
directory is first created. The lock is not held when it's created.
218
self._trace("create lock directory")
220
self.transport.mkdir(self.path, mode=mode)
221
except (TransportError, PathError) as e:
222
raise LockFailed(self, e)
224
def _attempt_lock(self):
225
"""Make the pending directory and attempt to rename into place.
227
If the rename succeeds, we read back the info file to check that we
230
If we fail to acquire the lock, this method is responsible for
231
cleaning up the pending directory if possible. (But it doesn't do
234
:returns: The nonce of the lock, if it was successfully acquired.
236
:raises LockContention: If the lock is held by someone else. The
237
exception contains the info of the current holder of the lock.
239
self._trace("lock_write...")
240
start_time = time.time()
242
tmpname = self._create_pending_dir()
243
except (errors.TransportError, PathError) as e:
244
self._trace("... failed to create pending dir, %s", e)
245
raise LockFailed(self, e)
248
self.transport.rename(tmpname, self._held_dir)
250
except (errors.TransportError, PathError, DirectoryNotEmpty,
251
FileExists, ResourceBusy) as e:
252
self._trace("... contention, %s", e)
253
other_holder = self.peek()
254
self._trace("other holder is %r" % other_holder)
256
self._handle_lock_contention(other_holder)
258
self._remove_pending_dir(tmpname)
260
except Exception as e:
261
self._trace("... lock failed, %s", e)
262
self._remove_pending_dir(tmpname)
264
# We must check we really got the lock, because Launchpad's sftp
265
# server at one time had a bug were the rename would successfully
266
# move the new directory into the existing directory, which was
267
# incorrect. It's possible some other servers or filesystems will
268
# have a similar bug allowing someone to think they got the lock
269
# when it's already held.
271
# See <https://bugs.launchpad.net/bzr/+bug/498378> for one case.
273
# Strictly the check is unnecessary and a waste of time for most
274
# people, but probably worth trapping if something is wrong.
276
self._trace("after locking, info=%r", info)
278
raise LockFailed(self, "lock was renamed into place, but "
280
if info.get('nonce') != self.nonce:
281
self._trace("rename succeeded, "
282
"but lock is still held by someone else")
283
raise LockContention(self)
284
self._lock_held = True
285
self._trace("... lock succeeded after %dms",
286
(time.time() - start_time) * 1000)
289
def _handle_lock_contention(self, other_holder):
290
"""A lock we want to take is held by someone else.
292
This function can: tell the user about it; possibly detect that it's
293
safe or appropriate to steal the lock, or just raise an exception.
295
If this function returns (without raising an exception) the lock will
298
:param other_holder: A LockHeldInfo for the current holder; note that
299
it might be None if the lock can be seen to be held but the info
302
if (other_holder is not None):
303
if other_holder.is_lock_holder_known_dead():
304
if self.get_config().get('locks.steal_dead'):
305
ui.ui_factory.show_user_warning(
307
lock_url=urlutils.join(self.transport.base, self.path),
308
other_holder_info=text_type(other_holder))
309
self.force_break(other_holder)
310
self._trace("stole lock from dead holder")
312
raise LockContention(self)
314
def _remove_pending_dir(self, tmpname):
315
"""Remove the pending directory
317
This is called if we failed to rename into place, so that the pending
318
dirs don't clutter up the lockdir.
320
self._trace("remove %s", tmpname)
322
self.transport.delete(tmpname + self.__INFO_NAME)
323
self.transport.rmdir(tmpname)
324
except PathError as e:
325
note(gettext("error removing pending lock: %s"), e)
327
def _create_pending_dir(self):
328
tmpname = '%s/%s.tmp' % (self.path, rand_chars(10))
330
self.transport.mkdir(tmpname)
332
# This may raise a FileExists exception
333
# which is okay, it will be caught later and determined
334
# to be a LockContention.
335
self._trace("lock directory does not exist, creating it")
336
self.create(mode=self._dir_modebits)
337
# After creating the lock directory, try again
338
self.transport.mkdir(tmpname)
339
info = LockHeldInfo.for_this_process(self.extra_holder_info)
340
self.nonce = info.get('nonce')
341
# We use put_file_non_atomic because we just created a new unique
342
# directory so we don't have to worry about files existing there.
343
# We'll rename the whole directory into place to get atomic
345
self.transport.put_bytes_non_atomic(tmpname + self.__INFO_NAME,
349
@only_raises(LockNotHeld, LockBroken)
351
"""Release a held lock
353
if self._fake_read_lock:
354
self._fake_read_lock = False
356
if not self._lock_held:
357
return lock.cant_unlock_not_held(self)
358
if self._locked_via_token:
359
self._locked_via_token = False
360
self._lock_held = False
362
old_nonce = self.nonce
363
# rename before deleting, because we can't atomically remove the
365
start_time = time.time()
366
self._trace("unlocking")
367
tmpname = '%s/releasing.%s.tmp' % (self.path, rand_chars(20))
368
# gotta own it to unlock
370
self.transport.rename(self._held_dir, tmpname)
371
self._lock_held = False
372
self.transport.delete(tmpname + self.__INFO_NAME)
374
self.transport.rmdir(tmpname)
375
except DirectoryNotEmpty as e:
376
# There might have been junk left over by a rename that moved
377
# another locker within the 'held' directory. do a slower
378
# deletion where we list the directory and remove everything
381
# Maybe this should be broader to allow for ftp servers with
382
# non-specific error messages?
383
self._trace("doing recursive deletion of non-empty directory "
385
self.transport.delete_tree(tmpname)
386
self._trace("... unlock succeeded after %dms",
387
(time.time() - start_time) * 1000)
388
result = lock.LockResult(self.transport.abspath(self.path),
390
for hook in self.hooks['lock_released']:
393
def break_lock(self):
394
"""Break a lock not held by this instance of LockDir.
396
This is a UI centric function: it uses the ui.ui_factory to
397
prompt for input if a lock is detected and there is any doubt about
398
it possibly being still active. force_break is the non-interactive
401
:returns: LockResult for the broken lock.
403
self._check_not_locked()
405
holder_info = self.peek()
406
except LockCorrupt as e:
407
# The lock info is corrupt.
408
if ui.ui_factory.get_boolean(u"Break (corrupt %r)" % (self,)):
409
self.force_break_corrupt(e.file_data)
411
if holder_info is not None:
412
if ui.ui_factory.confirm_action(
413
u"Break %(lock_info)s",
414
'breezy.lockdir.break',
415
dict(lock_info=text_type(holder_info))):
416
result = self.force_break(holder_info)
417
ui.ui_factory.show_message(
418
"Broke lock %s" % result.lock_url)
420
def force_break(self, dead_holder_info):
421
"""Release a lock held by another process.
423
WARNING: This should only be used when the other process is dead; if
424
it still thinks it has the lock there will be two concurrent writers.
425
In general the user's approval should be sought for lock breaks.
427
After the lock is broken it will not be held by any process.
428
It is possible that another process may sneak in and take the
429
lock before the breaking process acquires it.
431
:param dead_holder_info:
432
Must be the result of a previous LockDir.peek() call; this is used
433
to check that it's still held by the same process that the user
434
decided was dead. If this is not the current holder,
435
LockBreakMismatch is raised.
437
:returns: LockResult for the broken lock.
439
if not isinstance(dead_holder_info, LockHeldInfo):
440
raise ValueError("dead_holder_info: %r" % dead_holder_info)
441
self._check_not_locked()
442
current_info = self.peek()
443
if current_info is None:
444
# must have been recently released
446
if current_info != dead_holder_info:
447
raise LockBreakMismatch(self, current_info, dead_holder_info)
448
tmpname = '%s/broken.%s.tmp' % (self.path, rand_chars(20))
449
self.transport.rename(self._held_dir, tmpname)
450
# check that we actually broke the right lock, not someone else;
451
# there's a small race window between checking it and doing the
453
broken_info_path = tmpname + self.__INFO_NAME
454
broken_info = self._read_info_file(broken_info_path)
455
if broken_info != dead_holder_info:
456
raise LockBreakMismatch(self, broken_info, dead_holder_info)
457
self.transport.delete(broken_info_path)
458
self.transport.rmdir(tmpname)
459
result = lock.LockResult(self.transport.abspath(self.path),
460
current_info.get('nonce'))
461
for hook in self.hooks['lock_broken']:
465
def force_break_corrupt(self, corrupt_info_lines):
466
"""Release a lock that has been corrupted.
468
This is very similar to force_break, it except it doesn't assume that
469
self.peek() can work.
471
:param corrupt_info_lines: the lines of the corrupted info file, used
472
to check that the lock hasn't changed between reading the (corrupt)
473
info file and calling force_break_corrupt.
475
# XXX: this copes with unparseable info files, but what about missing
476
# info files? Or missing lock dirs?
477
self._check_not_locked()
478
tmpname = '%s/broken.%s.tmp' % (self.path, rand_chars(20))
479
self.transport.rename(self._held_dir, tmpname)
480
# check that we actually broke the right lock, not someone else;
481
# there's a small race window between checking it and doing the
483
broken_info_path = tmpname + self.__INFO_NAME
484
broken_content = self.transport.get_bytes(broken_info_path)
485
broken_lines = osutils.split_lines(broken_content)
486
if broken_lines != corrupt_info_lines:
487
raise LockBreakMismatch(self, broken_lines, corrupt_info_lines)
488
self.transport.delete(broken_info_path)
489
self.transport.rmdir(tmpname)
490
result = lock.LockResult(self.transport.abspath(self.path))
491
for hook in self.hooks['lock_broken']:
494
def _check_not_locked(self):
495
"""If the lock is held by this instance, raise an error."""
497
raise AssertionError("can't break own lock: %r" % self)
500
"""Make sure that the lock is still held by this locker.
502
This should only fail if the lock was broken by user intervention,
503
or if the lock has been affected by a bug.
505
If the lock is not thought to be held, raises LockNotHeld. If
506
the lock is thought to be held but has been broken, raises
509
if not self._lock_held:
510
raise LockNotHeld(self)
513
# no lock there anymore!
514
raise LockBroken(self)
515
if info.get('nonce') != self.nonce:
516
# there is a lock, but not ours
517
raise LockBroken(self)
519
def _read_info_file(self, path):
520
"""Read one given info file.
522
peek() reads the info file of the lock holder, if any.
524
return LockHeldInfo.from_info_file_bytes(
525
self.transport.get_bytes(path))
528
"""Check if the lock is held by anyone.
530
If it is held, this returns the lock info structure as a dict
531
which contains some information about the current lock holder.
532
Otherwise returns None.
535
info = self._read_info_file(self._held_info_path)
536
self._trace("peek -> held")
538
except NoSuchFile as e:
539
self._trace("peek -> not held")
541
def _prepare_info(self):
542
"""Write information about a pending lock to a temporary file.
545
def attempt_lock(self):
546
"""Take the lock; fail if it's already held.
548
If you wish to block until the lock can be obtained, call wait_lock()
551
:return: The lock token.
552
:raises LockContention: if the lock is held by someone else.
554
if self._fake_read_lock:
555
raise LockContention(self)
556
result = self._attempt_lock()
557
hook_result = lock.LockResult(self.transport.abspath(self.path),
559
for hook in self.hooks['lock_acquired']:
563
def lock_url_for_display(self):
564
"""Give a nicely-printable representation of the URL of this lock."""
565
# As local lock urls are correct we display them.
566
# We avoid displaying remote lock urls.
567
lock_url = self.transport.abspath(self.path)
568
if lock_url.startswith('file://'):
569
lock_url = lock_url.split('.bzr/')[0]
574
def wait_lock(self, timeout=None, poll=None, max_attempts=None):
575
"""Wait a certain period for a lock.
577
If the lock can be acquired within the bounded time, it
578
is taken and this returns. Otherwise, LockContention
579
is raised. Either way, this function should return within
580
approximately `timeout` seconds. (It may be a bit more if
581
a transport operation takes a long time to complete.)
583
:param timeout: Approximate maximum amount of time to wait for the
586
:param poll: Delay in seconds between retrying the lock.
588
:param max_attempts: Maximum number of times to try to lock.
590
:return: The lock token.
593
timeout = _DEFAULT_TIMEOUT_SECONDS
595
poll = _DEFAULT_POLL_SECONDS
596
# XXX: the transport interface doesn't let us guard against operations
597
# there taking a long time, so the total elapsed time or poll interval
598
# may be more than was requested.
599
deadline = time.time() + timeout
603
lock_url = self.lock_url_for_display()
607
return self.attempt_lock()
608
except LockContention:
609
# possibly report the blockage, then try again
611
# TODO: In a few cases, we find out that there's contention by
612
# reading the held info and observing that it's not ours. In
613
# those cases it's a bit redundant to read it again. However,
614
# the normal case (??) is that the rename fails and so we
615
# don't know who holds the lock. For simplicity we peek
617
new_info = self.peek()
618
if new_info is not None and new_info != last_info:
619
if last_info is None:
620
start = gettext('Unable to obtain')
622
start = gettext('Lock owner changed for')
624
msg = gettext('{0} lock {1} {2}.').format(start, lock_url,
626
if deadline_str is None:
627
deadline_str = time.strftime('%H:%M:%S',
628
time.localtime(deadline))
630
msg += '\n' + gettext(
631
'Will continue to try until %s, unless '
632
'you press Ctrl-C.') % deadline_str
633
msg += '\n' + gettext('See "brz help break-lock" for more.')
634
self._report_function(msg)
635
if (max_attempts is not None) and (attempt_count >= max_attempts):
636
self._trace("exceeded %d attempts")
637
raise LockContention(self)
638
if time.time() + poll < deadline:
639
self._trace("waiting %ss", poll)
642
# As timeout is always 0 for remote locks
643
# this block is applicable only for local
645
self._trace("timeout after waiting %ss", timeout)
646
raise LockContention('(local)', lock_url)
648
def leave_in_place(self):
649
self._locked_via_token = True
651
def dont_leave_in_place(self):
652
self._locked_via_token = False
654
def lock_write(self, token=None):
655
"""Wait for and acquire the lock.
657
:param token: if this is already locked, then lock_write will fail
658
unless the token matches the existing lock.
659
:returns: a token if this instance supports tokens, otherwise None.
660
:raises TokenLockingNotSupported: when a token is given but this
661
instance doesn't support using token locks.
662
:raises MismatchedToken: if the specified token doesn't match the token
663
of the existing lock.
665
A token should be passed in if you know that you have locked the object
666
some other way, and need to synchronise this object's state with that
669
XXX: docstring duplicated from LockableFiles.lock_write.
671
if token is not None:
672
self.validate_token(token)
674
self._lock_held = True
675
self._locked_via_token = True
678
return self.wait_lock()
681
"""Compatibility-mode shared lock.
683
LockDir doesn't support shared read-only locks, so this
684
just pretends that the lock is taken but really does nothing.
686
# At the moment Branches are commonly locked for read, but
687
# we can't rely on that remotely. Once this is cleaned up,
688
# reenable this warning to prevent it coming back in
690
## warn("LockDir.lock_read falls back to write lock")
691
if self._lock_held or self._fake_read_lock:
692
raise LockContention(self)
693
self._fake_read_lock = True
695
def validate_token(self, token):
696
if token is not None:
702
lock_token = info.get('nonce')
703
if token != lock_token:
704
raise errors.TokenMismatch(token, lock_token)
706
self._trace("revalidated by token %r", token)
708
def _trace(self, format, *args):
709
if 'lock' not in debug.debug_flags:
711
mutter(str(self) + ": " + (format % args))
713
def get_config(self):
714
"""Get the configuration that governs this lockdir."""
715
# XXX: This really should also use the locationconfig at least, but
716
# that seems a bit hard to hook up at the moment. -- mbp 20110329
717
# FIXME: The above is still true ;) -- vila 20110811
718
return config.GlobalStack()
721
class LockHeldInfo(object):
722
"""The information recorded about a held lock.
724
This information is recorded into the lock when it's taken, and it can be
725
read back by any process with access to the lockdir. It can be used, for
726
example, to tell the user who holds the lock, or to try to detect whether
727
the lock holder is still alive.
729
Prior to bzr 2.4 a simple dict was used instead of an object.
732
def __init__(self, info_dict):
733
self.info_dict = info_dict
736
"""Return a debugging representation of this object."""
737
return "%s(%r)" % (self.__class__.__name__, self.info_dict)
739
def __unicode__(self):
740
"""Return a user-oriented description of this object."""
741
d = self.to_readable_dict()
743
u'held by %(user)s on %(hostname)s (process #%(pid)s), '
744
u'acquired %(time_ago)s') % d)
747
__str__ = __unicode__
749
def to_readable_dict(self):
750
"""Turn the holder info into a dict of human-readable attributes.
752
For example, the start time is presented relative to the current time,
753
rather than as seconds since the epoch.
755
Returns a list of [user, hostname, pid, time_ago] all as readable
758
start_time = self.info_dict.get('start_time')
759
if start_time is None:
760
time_ago = '(unknown)'
762
time_ago = format_delta(
763
time.time() - int(self.info_dict['start_time']))
764
user = self.info_dict.get('user', '<unknown>')
765
hostname = self.info_dict.get('hostname', '<unknown>')
766
pid = self.info_dict.get('pid', '<unknown>')
773
def get(self, field_name):
774
"""Return the contents of a field from the lock info, or None."""
775
return self.info_dict.get(field_name)
778
def for_this_process(cls, extra_holder_info):
779
"""Return a new LockHeldInfo for a lock taken by this process.
782
hostname=get_host_name(),
783
pid=str(os.getpid()),
784
nonce=rand_chars(20),
785
start_time=str(int(time.time())),
786
user=get_username_for_lock_info(),
788
if extra_holder_info is not None:
789
info.update(extra_holder_info)
793
s = rio.Stanza(**self.info_dict)
797
def from_info_file_bytes(cls, info_file_bytes):
798
"""Construct from the contents of the held file."""
799
lines = osutils.split_lines(info_file_bytes)
801
stanza = rio.read_stanza(lines)
802
except ValueError as e:
803
mutter('Corrupt lock info file: %r', lines)
804
raise LockCorrupt("could not parse lock info file: " + str(e),
807
# see bug 185013; we fairly often end up with the info file being
808
# empty after an interruption; we could log a message here but
809
# there may not be much we can say
812
return cls(stanza.as_dict())
817
def __eq__(self, other):
818
"""Equality check for lock holders."""
819
if type(self) != type(other):
821
return self.info_dict == other.info_dict
823
def __ne__(self, other):
824
return not self == other
826
def is_locked_by_this_process(self):
827
"""True if this process seems to be the current lock holder."""
829
self.get('hostname') == get_host_name()
830
and self.get('pid') == str(os.getpid())
831
and self.get('user') == get_username_for_lock_info())
833
def is_lock_holder_known_dead(self):
834
"""True if the lock holder process is known to be dead.
836
False if it's either known to be still alive, or if we just can't tell.
838
We can be fairly sure the lock holder is dead if it declared the same
839
hostname and there is no process with the given pid alive. If people
840
have multiple machines with the same hostname this may cause trouble.
842
This doesn't check whether the lock holder is in fact the same process
843
calling this method. (In that case it will return true.)
845
if self.get('hostname') != get_host_name():
847
if self.get('hostname') == 'localhost':
850
if self.get('user') != get_username_for_lock_info():
851
# Could well be another local process by a different user, but
852
# just to be safe we won't conclude about this either.
854
pid_str = self.info_dict.get('pid', None)
856
mutter("no pid recorded in %r" % (self, ))
861
mutter("can't parse pid %r from %r"
864
return osutils.is_local_pid_dead(pid)
867
def get_username_for_lock_info():
868
"""Get a username suitable for putting into a lock.
870
It's ok if what's written here is not a proper email address as long
871
as it gives some clue who the user is.
874
return config.GlobalStack().get('email')
875
except config.NoWhoami:
876
return osutils.getuser_unicode()
added
removed
breezy/lockdir.py
