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
from __future__ import absolute_import
19
"""On-disk mutex protecting a resource
21
bzr on-disk objects are locked by the existence of a directory with a
22
particular name within the control directory. We use this rather than OS
23
internal locks (such as flock etc) because they can be seen across all
24
transports, including http.
26
Objects can be read if there is only physical read access; therefore
27
readers can never be required to create a lock, though they will
28
check whether a writer is using the lock. Writers can't detect
29
whether anyone else is reading from the resource as they write.
30
This works because of ordering constraints that make sure readers
31
see a consistent view of existing data.
33
Waiting for a lock must be done by polling; this can be aborted after
36
Locks must always be explicitly released, typically from a try/finally
37
block -- they are not released from a finalizer or when Python
40
Locks may fail to be released if the process is abruptly terminated
41
(machine stop, SIGKILL) or if a remote transport becomes permanently
42
disconnected. There is therefore a method to break an existing lock.
43
This should rarely be used, and generally only with user approval.
44
Locks contain some information on when the lock was taken and by who
45
which may guide in deciding whether it can safely be broken. (This is
46
similar to the messages displayed by emacs and vim.) Note that if the
47
lock holder is still alive they will get no notification that the lock
48
has been broken and will continue their work -- so it is important to be
49
sure they are actually dead.
51
A lock is represented on disk by a directory of a particular name,
52
containing an information file. Taking a lock is done by renaming a
53
temporary directory into place. We use temporary directories because
54
for all known transports and filesystems we believe that exactly one
55
attempt to claim the lock will succeed and the others will fail. (Files
56
won't do because some filesystems or transports only have
57
rename-and-overwrite, making it hard to tell who won.)
59
The desired characteristics are:
61
* Locks are not reentrant. (That is, a client that tries to take a
62
lock it already holds may deadlock or fail.)
63
* Stale locks can be guessed at by a heuristic
64
* Lost locks can be broken by any client
65
* Failed lock operations leave little or no mess
66
* Deadlocks are avoided by having a timeout always in use, clients
67
desiring indefinite waits can retry or set a silly big timeout.
69
Storage formats use the locks, and also need to consider concurrency
70
issues underneath the lock. A format may choose not to use a lock
71
at all for some operations.
73
LockDirs always operate over a Transport. The transport may be readonly, in
74
which case the lock can be queried but not acquired.
76
Locks are identified by a path name, relative to a base transport.
78
Calling code will typically want to make sure there is exactly one LockDir
79
object per actual lock on disk. This module does nothing to prevent aliasing
80
and deadlocks will likely occur if the locks are aliased.
82
In the future we may add a "freshen" method which can be called
83
by a lock holder to check that their lock has not been broken, and to
84
update the timestamp within it.
88
>>> from bzrlib.transport.memory import MemoryTransport
89
>>> # typically will be obtained from a BzrDir, Branch, etc
90
>>> t = MemoryTransport()
91
>>> l = LockDir(t, 'sample-lock')
93
>>> token = l.wait_lock()
94
>>> # do something here
97
Some classes of stale locks can be predicted by checking: the host name is the
98
same as the local host name; the user name is the same as the local user; the
99
process id no longer exists. The check on user name is not strictly necessary
100
but helps protect against colliding host names.
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
125
from bzrlib.decorators import only_raises
126
from bzrlib.errors import (
140
from bzrlib.trace import mutter, note
141
from bzrlib.osutils import format_delta, rand_chars, get_host_name
142
from bzrlib.i18n import gettext
144
from bzrlib.lazy_import import lazy_import
145
lazy_import(globals(), """
146
from bzrlib import rio
149
# XXX: At the moment there is no consideration of thread safety on LockDir
150
# objects. This should perhaps be updated - e.g. if two threads try to take a
151
# lock at the same time they should *both* get it. But then that's unlikely
154
# TODO: Perhaps store some kind of note like the bzr command line in the lock
157
# TODO: Some kind of callback run while polling a lock to show progress
160
# TODO: Make sure to pass the right file and directory mode bits to all
161
# files/dirs created.
164
_DEFAULT_TIMEOUT_SECONDS = 30
165
_DEFAULT_POLL_SECONDS = 1.0
168
class LockDir(lock.Lock):
169
"""Write-lock guarding access to data.
172
__INFO_NAME = '/info'
174
def __init__(self, transport, path, file_modebits=0644, dir_modebits=0755,
175
extra_holder_info=None):
176
"""Create a new LockDir object.
178
The LockDir is initially unlocked - this just creates the object.
180
:param transport: Transport which will contain the lock
182
:param path: Path to the lock within the base directory of the
185
:param extra_holder_info: If passed, {str:str} dict of extra or
186
updated information to insert into the info file when the lock is
189
self.transport = transport
191
self._lock_held = False
192
self._locked_via_token = False
193
self._fake_read_lock = False
194
self._held_dir = path + '/held'
195
self._held_info_path = self._held_dir + self.__INFO_NAME
196
self._file_modebits = file_modebits
197
self._dir_modebits = dir_modebits
198
self._report_function = note
199
self.extra_holder_info = extra_holder_info
200
self._warned_about_lock_holder = None
203
return '%s(%s%s)' % (self.__class__.__name__,
207
is_held = property(lambda self: self._lock_held)
209
def create(self, mode=None):
210
"""Create the on-disk lock.
212
This is typically only called when the object/directory containing the
213
directory is first created. The lock is not held when it's created.
215
self._trace("create lock directory")
217
self.transport.mkdir(self.path, mode=mode)
218
except (TransportError, PathError), e:
219
raise LockFailed(self, e)
221
def _attempt_lock(self):
222
"""Make the pending directory and attempt to rename into place.
224
If the rename succeeds, we read back the info file to check that we
227
If we fail to acquire the lock, this method is responsible for
228
cleaning up the pending directory if possible. (But it doesn't do
231
:returns: The nonce of the lock, if it was successfully acquired.
233
:raises LockContention: If the lock is held by someone else. The
234
exception contains the info of the current holder of the lock.
236
self._trace("lock_write...")
237
start_time = time.time()
239
tmpname = self._create_pending_dir()
240
except (errors.TransportError, PathError), e:
241
self._trace("... failed to create pending dir, %s", e)
242
raise LockFailed(self, e)
245
self.transport.rename(tmpname, self._held_dir)
247
except (errors.TransportError, PathError, DirectoryNotEmpty,
248
FileExists, ResourceBusy), e:
249
self._trace("... contention, %s", e)
250
other_holder = self.peek()
251
self._trace("other holder is %r" % other_holder)
253
self._handle_lock_contention(other_holder)
255
self._remove_pending_dir(tmpname)
258
self._trace("... lock failed, %s", e)
259
self._remove_pending_dir(tmpname)
261
# We must check we really got the lock, because Launchpad's sftp
262
# server at one time had a bug were the rename would successfully
263
# move the new directory into the existing directory, which was
264
# incorrect. It's possible some other servers or filesystems will
265
# have a similar bug allowing someone to think they got the lock
266
# when it's already held.
268
# See <https://bugs.launchpad.net/bzr/+bug/498378> for one case.
270
# Strictly the check is unnecessary and a waste of time for most
271
# people, but probably worth trapping if something is wrong.
273
self._trace("after locking, info=%r", info)
275
raise LockFailed(self, "lock was renamed into place, but "
277
if info.get('nonce') != self.nonce:
278
self._trace("rename succeeded, "
279
"but lock is still held by someone else")
280
raise LockContention(self)
281
self._lock_held = True
282
self._trace("... lock succeeded after %dms",
283
(time.time() - start_time) * 1000)
286
def _handle_lock_contention(self, other_holder):
287
"""A lock we want to take is held by someone else.
289
This function can: tell the user about it; possibly detect that it's
290
safe or appropriate to steal the lock, or just raise an exception.
292
If this function returns (without raising an exception) the lock will
295
:param other_holder: A LockHeldInfo for the current holder; note that
296
it might be None if the lock can be seen to be held but the info
299
if (other_holder is not None):
300
if other_holder.is_lock_holder_known_dead():
301
if self.get_config().get('locks.steal_dead'):
302
ui.ui_factory.show_user_warning(
304
lock_url=urlutils.join(self.transport.base, self.path),
305
other_holder_info=unicode(other_holder))
306
self.force_break(other_holder)
307
self._trace("stole lock from dead holder")
309
raise LockContention(self)
311
def _remove_pending_dir(self, tmpname):
312
"""Remove the pending directory
314
This is called if we failed to rename into place, so that the pending
315
dirs don't clutter up the lockdir.
317
self._trace("remove %s", tmpname)
319
self.transport.delete(tmpname + self.__INFO_NAME)
320
self.transport.rmdir(tmpname)
322
note(gettext("error removing pending lock: %s"), e)
324
def _create_pending_dir(self):
325
tmpname = '%s/%s.tmp' % (self.path, rand_chars(10))
327
self.transport.mkdir(tmpname)
329
# This may raise a FileExists exception
330
# which is okay, it will be caught later and determined
331
# to be a LockContention.
332
self._trace("lock directory does not exist, creating it")
333
self.create(mode=self._dir_modebits)
334
# After creating the lock directory, try again
335
self.transport.mkdir(tmpname)
336
info = LockHeldInfo.for_this_process(self.extra_holder_info)
337
self.nonce = info.get('nonce')
338
# We use put_file_non_atomic because we just created a new unique
339
# directory so we don't have to worry about files existing there.
340
# We'll rename the whole directory into place to get atomic
342
self.transport.put_bytes_non_atomic(tmpname + self.__INFO_NAME,
346
@only_raises(LockNotHeld, LockBroken)
348
"""Release a held lock
350
if self._fake_read_lock:
351
self._fake_read_lock = False
353
if not self._lock_held:
354
return lock.cant_unlock_not_held(self)
355
if self._locked_via_token:
356
self._locked_via_token = False
357
self._lock_held = False
359
old_nonce = self.nonce
360
# rename before deleting, because we can't atomically remove the
362
start_time = time.time()
363
self._trace("unlocking")
364
tmpname = '%s/releasing.%s.tmp' % (self.path, rand_chars(20))
365
# gotta own it to unlock
367
self.transport.rename(self._held_dir, tmpname)
368
self._lock_held = False
369
self.transport.delete(tmpname + self.__INFO_NAME)
371
self.transport.rmdir(tmpname)
372
except DirectoryNotEmpty, e:
373
# There might have been junk left over by a rename that moved
374
# another locker within the 'held' directory. do a slower
375
# deletion where we list the directory and remove everything
378
# Maybe this should be broader to allow for ftp servers with
379
# non-specific error messages?
380
self._trace("doing recursive deletion of non-empty directory "
382
self.transport.delete_tree(tmpname)
383
self._trace("... unlock succeeded after %dms",
384
(time.time() - start_time) * 1000)
385
result = lock.LockResult(self.transport.abspath(self.path),
387
for hook in self.hooks['lock_released']:
390
def break_lock(self):
391
"""Break a lock not held by this instance of LockDir.
393
This is a UI centric function: it uses the ui.ui_factory to
394
prompt for input if a lock is detected and there is any doubt about
395
it possibly being still active. force_break is the non-interactive
398
:returns: LockResult for the broken lock.
400
self._check_not_locked()
402
holder_info = self.peek()
403
except LockCorrupt, e:
404
# The lock info is corrupt.
405
if ui.ui_factory.get_boolean(u"Break (corrupt %r)" % (self,)):
406
self.force_break_corrupt(e.file_data)
408
if holder_info is not None:
409
if ui.ui_factory.confirm_action(
410
u"Break %(lock_info)s",
411
'bzrlib.lockdir.break',
412
dict(lock_info=unicode(holder_info))):
413
result = self.force_break(holder_info)
414
ui.ui_factory.show_message(
415
"Broke lock %s" % result.lock_url)
417
def force_break(self, dead_holder_info):
418
"""Release a lock held by another process.
420
WARNING: This should only be used when the other process is dead; if
421
it still thinks it has the lock there will be two concurrent writers.
422
In general the user's approval should be sought for lock breaks.
424
After the lock is broken it will not be held by any process.
425
It is possible that another process may sneak in and take the
426
lock before the breaking process acquires it.
428
:param dead_holder_info:
429
Must be the result of a previous LockDir.peek() call; this is used
430
to check that it's still held by the same process that the user
431
decided was dead. If this is not the current holder,
432
LockBreakMismatch is raised.
434
:returns: LockResult for the broken lock.
436
if not isinstance(dead_holder_info, LockHeldInfo):
437
raise ValueError("dead_holder_info: %r" % dead_holder_info)
438
self._check_not_locked()
439
current_info = self.peek()
440
if current_info is None:
441
# must have been recently released
443
if current_info != dead_holder_info:
444
raise LockBreakMismatch(self, current_info, dead_holder_info)
445
tmpname = '%s/broken.%s.tmp' % (self.path, rand_chars(20))
446
self.transport.rename(self._held_dir, tmpname)
447
# check that we actually broke the right lock, not someone else;
448
# there's a small race window between checking it and doing the
450
broken_info_path = tmpname + self.__INFO_NAME
451
broken_info = self._read_info_file(broken_info_path)
452
if broken_info != dead_holder_info:
453
raise LockBreakMismatch(self, broken_info, dead_holder_info)
454
self.transport.delete(broken_info_path)
455
self.transport.rmdir(tmpname)
456
result = lock.LockResult(self.transport.abspath(self.path),
457
current_info.get('nonce'))
458
for hook in self.hooks['lock_broken']:
462
def force_break_corrupt(self, corrupt_info_lines):
463
"""Release a lock that has been corrupted.
465
This is very similar to force_break, it except it doesn't assume that
466
self.peek() can work.
468
:param corrupt_info_lines: the lines of the corrupted info file, used
469
to check that the lock hasn't changed between reading the (corrupt)
470
info file and calling force_break_corrupt.
472
# XXX: this copes with unparseable info files, but what about missing
473
# info files? Or missing lock dirs?
474
self._check_not_locked()
475
tmpname = '%s/broken.%s.tmp' % (self.path, rand_chars(20))
476
self.transport.rename(self._held_dir, tmpname)
477
# check that we actually broke the right lock, not someone else;
478
# there's a small race window between checking it and doing the
480
broken_info_path = tmpname + self.__INFO_NAME
481
broken_content = self.transport.get_bytes(broken_info_path)
482
broken_lines = osutils.split_lines(broken_content)
483
if broken_lines != corrupt_info_lines:
484
raise LockBreakMismatch(self, broken_lines, corrupt_info_lines)
485
self.transport.delete(broken_info_path)
486
self.transport.rmdir(tmpname)
487
result = lock.LockResult(self.transport.abspath(self.path))
488
for hook in self.hooks['lock_broken']:
491
def _check_not_locked(self):
492
"""If the lock is held by this instance, raise an error."""
494
raise AssertionError("can't break own lock: %r" % self)
497
"""Make sure that the lock is still held by this locker.
499
This should only fail if the lock was broken by user intervention,
500
or if the lock has been affected by a bug.
502
If the lock is not thought to be held, raises LockNotHeld. If
503
the lock is thought to be held but has been broken, raises
506
if not self._lock_held:
507
raise LockNotHeld(self)
510
# no lock there anymore!
511
raise LockBroken(self)
512
if info.get('nonce') != self.nonce:
513
# there is a lock, but not ours
514
raise LockBroken(self)
516
def _read_info_file(self, path):
517
"""Read one given info file.
519
peek() reads the info file of the lock holder, if any.
521
return LockHeldInfo.from_info_file_bytes(
522
self.transport.get_bytes(path))
525
"""Check if the lock is held by anyone.
527
If it is held, this returns the lock info structure as a dict
528
which contains some information about the current lock holder.
529
Otherwise returns None.
532
info = self._read_info_file(self._held_info_path)
533
self._trace("peek -> held")
535
except NoSuchFile, e:
536
self._trace("peek -> not held")
538
def _prepare_info(self):
539
"""Write information about a pending lock to a temporary file.
542
def attempt_lock(self):
543
"""Take the lock; fail if it's already held.
545
If you wish to block until the lock can be obtained, call wait_lock()
548
:return: The lock token.
549
:raises LockContention: if the lock is held by someone else.
551
if self._fake_read_lock:
552
raise LockContention(self)
553
result = self._attempt_lock()
554
hook_result = lock.LockResult(self.transport.abspath(self.path),
556
for hook in self.hooks['lock_acquired']:
560
def lock_url_for_display(self):
561
"""Give a nicely-printable representation of the URL of this lock."""
562
# As local lock urls are correct we display them.
563
# We avoid displaying remote lock urls.
564
lock_url = self.transport.abspath(self.path)
565
if lock_url.startswith('file://'):
566
lock_url = lock_url.split('.bzr/')[0]
571
def wait_lock(self, timeout=None, poll=None, max_attempts=None):
572
"""Wait a certain period for a lock.
574
If the lock can be acquired within the bounded time, it
575
is taken and this returns. Otherwise, LockContention
576
is raised. Either way, this function should return within
577
approximately `timeout` seconds. (It may be a bit more if
578
a transport operation takes a long time to complete.)
580
:param timeout: Approximate maximum amount of time to wait for the
583
:param poll: Delay in seconds between retrying the lock.
585
:param max_attempts: Maximum number of times to try to lock.
587
:return: The lock token.
590
timeout = _DEFAULT_TIMEOUT_SECONDS
592
poll = _DEFAULT_POLL_SECONDS
593
# XXX: the transport interface doesn't let us guard against operations
594
# there taking a long time, so the total elapsed time or poll interval
595
# may be more than was requested.
596
deadline = time.time() + timeout
600
lock_url = self.lock_url_for_display()
604
return self.attempt_lock()
605
except LockContention:
606
# possibly report the blockage, then try again
608
# TODO: In a few cases, we find out that there's contention by
609
# reading the held info and observing that it's not ours. In
610
# those cases it's a bit redundant to read it again. However,
611
# the normal case (??) is that the rename fails and so we
612
# don't know who holds the lock. For simplicity we peek
614
new_info = self.peek()
615
if new_info is not None and new_info != last_info:
616
if last_info is None:
617
start = gettext('Unable to obtain')
619
start = gettext('Lock owner changed for')
621
msg = gettext('{0} lock {1} {2}.').format(start, lock_url,
623
if deadline_str is None:
624
deadline_str = time.strftime('%H:%M:%S',
625
time.localtime(deadline))
627
msg += '\n' + gettext(
628
'Will continue to try until %s, unless '
629
'you press Ctrl-C.') % deadline_str
630
msg += '\n' + gettext('See "bzr help break-lock" for more.')
631
self._report_function(msg)
632
if (max_attempts is not None) and (attempt_count >= max_attempts):
633
self._trace("exceeded %d attempts")
634
raise LockContention(self)
635
if time.time() + poll < deadline:
636
self._trace("waiting %ss", poll)
639
# As timeout is always 0 for remote locks
640
# this block is applicable only for local
642
self._trace("timeout after waiting %ss", timeout)
643
raise LockContention('(local)', lock_url)
645
def leave_in_place(self):
646
self._locked_via_token = True
648
def dont_leave_in_place(self):
649
self._locked_via_token = False
651
def lock_write(self, token=None):
652
"""Wait for and acquire the lock.
654
:param token: if this is already locked, then lock_write will fail
655
unless the token matches the existing lock.
656
:returns: a token if this instance supports tokens, otherwise None.
657
:raises TokenLockingNotSupported: when a token is given but this
658
instance doesn't support using token locks.
659
:raises MismatchedToken: if the specified token doesn't match the token
660
of the existing lock.
662
A token should be passed in if you know that you have locked the object
663
some other way, and need to synchronise this object's state with that
666
XXX: docstring duplicated from LockableFiles.lock_write.
668
if token is not None:
669
self.validate_token(token)
671
self._lock_held = True
672
self._locked_via_token = True
675
return self.wait_lock()
678
"""Compatibility-mode shared lock.
680
LockDir doesn't support shared read-only locks, so this
681
just pretends that the lock is taken but really does nothing.
683
# At the moment Branches are commonly locked for read, but
684
# we can't rely on that remotely. Once this is cleaned up,
685
# reenable this warning to prevent it coming back in
687
## warn("LockDir.lock_read falls back to write lock")
688
if self._lock_held or self._fake_read_lock:
689
raise LockContention(self)
690
self._fake_read_lock = True
692
def validate_token(self, token):
693
if token is not None:
699
lock_token = info.get('nonce')
700
if token != lock_token:
701
raise errors.TokenMismatch(token, lock_token)
703
self._trace("revalidated by token %r", token)
705
def _trace(self, format, *args):
706
if 'lock' not in debug.debug_flags:
708
mutter(str(self) + ": " + (format % args))
710
def get_config(self):
711
"""Get the configuration that governs this lockdir."""
712
# XXX: This really should also use the locationconfig at least, but
713
# that seems a bit hard to hook up at the moment. -- mbp 20110329
714
# FIXME: The above is still true ;) -- vila 20110811
715
return config.GlobalStack()
718
class LockHeldInfo(object):
719
"""The information recorded about a held lock.
721
This information is recorded into the lock when it's taken, and it can be
722
read back by any process with access to the lockdir. It can be used, for
723
example, to tell the user who holds the lock, or to try to detect whether
724
the lock holder is still alive.
726
Prior to bzr 2.4 a simple dict was used instead of an object.
729
def __init__(self, info_dict):
730
self.info_dict = info_dict
733
"""Return a debugging representation of this object."""
734
return "%s(%r)" % (self.__class__.__name__, self.info_dict)
736
def __unicode__(self):
737
"""Return a user-oriented description of this object."""
738
d = self.to_readable_dict()
740
u'held by %(user)s on %(hostname)s (process #%(pid)s), '
741
u'acquired %(time_ago)s') % d)
743
def to_readable_dict(self):
744
"""Turn the holder info into a dict of human-readable attributes.
746
For example, the start time is presented relative to the current time,
747
rather than as seconds since the epoch.
749
Returns a list of [user, hostname, pid, time_ago] all as readable
752
start_time = self.info_dict.get('start_time')
753
if start_time is None:
754
time_ago = '(unknown)'
756
time_ago = format_delta(
757
time.time() - int(self.info_dict['start_time']))
758
user = self.info_dict.get('user', '<unknown>')
759
hostname = self.info_dict.get('hostname', '<unknown>')
760
pid = self.info_dict.get('pid', '<unknown>')
767
def get(self, field_name):
768
"""Return the contents of a field from the lock info, or None."""
769
return self.info_dict.get(field_name)
772
def for_this_process(cls, extra_holder_info):
773
"""Return a new LockHeldInfo for a lock taken by this process.
776
hostname=get_host_name(),
777
pid=str(os.getpid()),
778
nonce=rand_chars(20),
779
start_time=str(int(time.time())),
780
user=get_username_for_lock_info(),
782
if extra_holder_info is not None:
783
info.update(extra_holder_info)
787
s = rio.Stanza(**self.info_dict)
791
def from_info_file_bytes(cls, info_file_bytes):
792
"""Construct from the contents of the held file."""
793
lines = osutils.split_lines(info_file_bytes)
795
stanza = rio.read_stanza(lines)
796
except ValueError, e:
797
mutter('Corrupt lock info file: %r', lines)
798
raise LockCorrupt("could not parse lock info file: " + str(e),
801
# see bug 185013; we fairly often end up with the info file being
802
# empty after an interruption; we could log a message here but
803
# there may not be much we can say
806
return cls(stanza.as_dict())
808
def __cmp__(self, other):
809
"""Value comparison of lock holders."""
811
cmp(type(self), type(other))
812
or cmp(self.info_dict, other.info_dict))
814
def is_locked_by_this_process(self):
815
"""True if this process seems to be the current lock holder."""
817
self.get('hostname') == get_host_name()
818
and self.get('pid') == str(os.getpid())
819
and self.get('user') == get_username_for_lock_info())
821
def is_lock_holder_known_dead(self):
822
"""True if the lock holder process is known to be dead.
824
False if it's either known to be still alive, or if we just can't tell.
826
We can be fairly sure the lock holder is dead if it declared the same
827
hostname and there is no process with the given pid alive. If people
828
have multiple machines with the same hostname this may cause trouble.
830
This doesn't check whether the lock holder is in fact the same process
831
calling this method. (In that case it will return true.)
833
if self.get('hostname') != get_host_name():
835
if self.get('hostname') == 'localhost':
838
if self.get('user') != get_username_for_lock_info():
839
# Could well be another local process by a different user, but
840
# just to be safe we won't conclude about this either.
842
pid_str = self.info_dict.get('pid', None)
844
mutter("no pid recorded in %r" % (self, ))
849
mutter("can't parse pid %r from %r"
852
return osutils.is_local_pid_dead(pid)
855
def get_username_for_lock_info():
856
"""Get a username suitable for putting into a lock.
858
It's ok if what's written here is not a proper email address as long
859
as it gives some clue who the user is.
862
return config.GlobalConfig().username()
863
except errors.NoWhoami:
864
return osutils.getuser_unicode()
added
removed
bzrlib/lockdir.py
