238
226
except (errors.TransportError, PathError), e:
239
227
self._trace("... failed to create pending dir, %s", e)
240
228
raise LockFailed(self, e)
243
self.transport.rename(tmpname, self._held_dir)
245
except (errors.TransportError, PathError, DirectoryNotEmpty,
246
FileExists, ResourceBusy), e:
247
self._trace("... contention, %s", e)
248
other_holder = self.peek()
249
self._trace("other holder is %r" % other_holder)
251
self._handle_lock_contention(other_holder)
253
self._remove_pending_dir(tmpname)
256
self._trace("... lock failed, %s", e)
257
self._remove_pending_dir(tmpname)
230
self.transport.rename(tmpname, self._held_dir)
231
except (errors.TransportError, PathError, DirectoryNotEmpty,
232
FileExists, ResourceBusy), e:
233
self._trace("... contention, %s", e)
234
self._remove_pending_dir(tmpname)
235
raise LockContention(self)
237
self._trace("... lock failed, %s", e)
238
self._remove_pending_dir(tmpname)
259
240
# We must check we really got the lock, because Launchpad's sftp
260
241
# server at one time had a bug were the rename would successfully
261
242
# move the new directory into the existing directory, which was
281
262
(time.time() - start_time) * 1000)
282
263
return self.nonce
284
def _handle_lock_contention(self, other_holder):
285
"""A lock we want to take is held by someone else.
287
This function can: tell the user about it; possibly detect that it's
288
safe or appropriate to steal the lock, or just raise an exception.
290
If this function returns (without raising an exception) the lock will
293
:param other_holder: A LockHeldInfo for the current holder; note that
294
it might be None if the lock can be seen to be held but the info
297
if (other_holder is not None):
298
if other_holder.is_lock_holder_known_dead():
299
if self.get_config().get('locks.steal_dead'):
300
ui.ui_factory.show_user_warning(
302
lock_url=urlutils.join(self.transport.base, self.path),
303
other_holder_info=unicode(other_holder))
304
self.force_break(other_holder)
305
self._trace("stole lock from dead holder")
307
raise LockContention(self)
309
265
def _remove_pending_dir(self, tmpname):
310
266
"""Remove the pending directory
400
355
holder_info = self.peek()
401
356
except LockCorrupt, e:
402
357
# The lock info is corrupt.
403
if ui.ui_factory.get_boolean(u"Break (corrupt %r)" % (self,)):
358
if bzrlib.ui.ui_factory.get_boolean("Break (corrupt %r)" % (self,)):
404
359
self.force_break_corrupt(e.file_data)
406
361
if holder_info is not None:
407
if ui.ui_factory.confirm_action(
408
u"Break %(lock_info)s",
409
'bzrlib.lockdir.break',
410
dict(lock_info=unicode(holder_info))):
362
lock_info = '\n'.join(self._format_lock_info(holder_info))
363
if bzrlib.ui.ui_factory.confirm_action(
364
"Break %(lock_info)s", 'bzrlib.lockdir.break',
365
dict(lock_info=lock_info)):
411
366
result = self.force_break(holder_info)
412
ui.ui_factory.show_message(
367
bzrlib.ui.ui_factory.show_message(
413
368
"Broke lock %s" % result.lock_url)
415
370
def force_break(self, dead_holder_info):
419
374
it still thinks it has the lock there will be two concurrent writers.
420
375
In general the user's approval should be sought for lock breaks.
377
dead_holder_info must be the result of a previous LockDir.peek() call;
378
this is used to check that it's still held by the same process that
379
the user decided was dead. If this is not the current holder,
380
LockBreakMismatch is raised.
422
382
After the lock is broken it will not be held by any process.
423
383
It is possible that another process may sneak in and take the
424
384
lock before the breaking process acquires it.
426
:param dead_holder_info:
427
Must be the result of a previous LockDir.peek() call; this is used
428
to check that it's still held by the same process that the user
429
decided was dead. If this is not the current holder,
430
LockBreakMismatch is raised.
432
386
:returns: LockResult for the broken lock.
434
if not isinstance(dead_holder_info, LockHeldInfo):
388
if not isinstance(dead_holder_info, dict):
435
389
raise ValueError("dead_holder_info: %r" % dead_holder_info)
436
390
self._check_not_locked()
437
391
current_info = self.peek()
536
489
def _prepare_info(self):
537
490
"""Write information about a pending lock to a temporary file.
492
# XXX: is creating this here inefficient?
493
config = bzrlib.config.GlobalConfig()
495
user = config.username()
496
except errors.NoWhoami:
497
user = osutils.getuser_unicode()
498
s = rio.Stanza(hostname=get_host_name(),
499
pid=str(os.getpid()),
500
start_time=str(int(time.time())),
506
def _parse_info(self, info_bytes):
507
lines = osutils.split_lines(info_bytes)
509
stanza = rio.read_stanza(lines)
510
except ValueError, e:
511
mutter('Corrupt lock info file: %r', lines)
512
raise LockCorrupt("could not parse lock info file: " + str(e),
515
# see bug 185013; we fairly often end up with the info file being
516
# empty after an interruption; we could log a message here but
517
# there may not be much we can say
520
return stanza.as_dict()
540
522
def attempt_lock(self):
541
523
"""Take the lock; fail if it's already held.
612
582
new_info = self.peek()
613
583
if new_info is not None and new_info != last_info:
614
584
if last_info is None:
615
start = gettext('Unable to obtain')
585
start = 'Unable to obtain'
617
start = gettext('Lock owner changed for')
587
start = 'Lock owner changed for'
618
588
last_info = new_info
619
msg = gettext('{0} lock {1} {2}.').format(start, lock_url,
589
formatted_info = self._format_lock_info(new_info)
621
590
if deadline_str is None:
622
591
deadline_str = time.strftime('%H:%M:%S',
623
time.localtime(deadline))
592
time.localtime(deadline))
593
# As local lock urls are correct we display them.
594
# We avoid displaying remote lock urls.
595
lock_url = self.transport.abspath(self.path)
596
if lock_url.startswith('file://'):
597
lock_url = lock_url.split('.bzr/')[0]
600
user, hostname, pid, time_ago = formatted_info
601
msg = ('%s lock %s ' # lock_url
605
'[process #%s], ' # pid
606
'acquired %s.') # time ago
607
msg_args = [start, lock_url, user, hostname, pid, time_ago]
625
msg += '\n' + gettext(
626
'Will continue to try until %s, unless '
627
'you press Ctrl-C.') % deadline_str
628
msg += '\n' + gettext('See "bzr help break-lock" for more.')
629
self._report_function(msg)
609
msg += ('\nWill continue to try until %s, unless '
611
msg_args.append(deadline_str)
612
msg += '\nSee "bzr help break-lock" for more.'
613
self._report_function(msg, *msg_args)
630
614
if (max_attempts is not None) and (attempt_count >= max_attempts):
631
615
self._trace("exceeded %d attempts")
632
616
raise LockContention(self)
704
705
if 'lock' not in debug.debug_flags:
706
707
mutter(str(self) + ": " + (format % args))
708
def get_config(self):
709
"""Get the configuration that governs this lockdir."""
710
# XXX: This really should also use the locationconfig at least, but
711
# that seems a bit hard to hook up at the moment. -- mbp 20110329
712
# FIXME: The above is still true ;) -- vila 20110811
713
return config.GlobalStack()
716
class LockHeldInfo(object):
717
"""The information recorded about a held lock.
719
This information is recorded into the lock when it's taken, and it can be
720
read back by any process with access to the lockdir. It can be used, for
721
example, to tell the user who holds the lock, or to try to detect whether
722
the lock holder is still alive.
724
Prior to bzr 2.4 a simple dict was used instead of an object.
727
def __init__(self, info_dict):
728
self.info_dict = info_dict
731
"""Return a debugging representation of this object."""
732
return "%s(%r)" % (self.__class__.__name__, self.info_dict)
734
def __unicode__(self):
735
"""Return a user-oriented description of this object."""
736
d = self.to_readable_dict()
738
u'held by %(user)s on %(hostname)s (process #%(pid)s), '
739
u'acquired %(time_ago)s') % d)
741
def to_readable_dict(self):
742
"""Turn the holder info into a dict of human-readable attributes.
744
For example, the start time is presented relative to the current time,
745
rather than as seconds since the epoch.
747
Returns a list of [user, hostname, pid, time_ago] all as readable
750
start_time = self.info_dict.get('start_time')
751
if start_time is None:
752
time_ago = '(unknown)'
754
time_ago = format_delta(
755
time.time() - int(self.info_dict['start_time']))
756
user = self.info_dict.get('user', '<unknown>')
757
hostname = self.info_dict.get('hostname', '<unknown>')
758
pid = self.info_dict.get('pid', '<unknown>')
765
def get(self, field_name):
766
"""Return the contents of a field from the lock info, or None."""
767
return self.info_dict.get(field_name)
770
def for_this_process(cls, extra_holder_info):
771
"""Return a new LockHeldInfo for a lock taken by this process.
774
hostname=get_host_name(),
775
pid=str(os.getpid()),
776
nonce=rand_chars(20),
777
start_time=str(int(time.time())),
778
user=get_username_for_lock_info(),
780
if extra_holder_info is not None:
781
info.update(extra_holder_info)
785
s = rio.Stanza(**self.info_dict)
789
def from_info_file_bytes(cls, info_file_bytes):
790
"""Construct from the contents of the held file."""
791
lines = osutils.split_lines(info_file_bytes)
793
stanza = rio.read_stanza(lines)
794
except ValueError, e:
795
mutter('Corrupt lock info file: %r', lines)
796
raise LockCorrupt("could not parse lock info file: " + str(e),
799
# see bug 185013; we fairly often end up with the info file being
800
# empty after an interruption; we could log a message here but
801
# there may not be much we can say
804
return cls(stanza.as_dict())
806
def __cmp__(self, other):
807
"""Value comparison of lock holders."""
809
cmp(type(self), type(other))
810
or cmp(self.info_dict, other.info_dict))
812
def is_locked_by_this_process(self):
813
"""True if this process seems to be the current lock holder."""
815
self.get('hostname') == get_host_name()
816
and self.get('pid') == str(os.getpid())
817
and self.get('user') == get_username_for_lock_info())
819
def is_lock_holder_known_dead(self):
820
"""True if the lock holder process is known to be dead.
822
False if it's either known to be still alive, or if we just can't tell.
824
We can be fairly sure the lock holder is dead if it declared the same
825
hostname and there is no process with the given pid alive. If people
826
have multiple machines with the same hostname this may cause trouble.
828
This doesn't check whether the lock holder is in fact the same process
829
calling this method. (In that case it will return true.)
831
if self.get('hostname') != get_host_name():
833
if self.get('hostname') == 'localhost':
836
if self.get('user') != get_username_for_lock_info():
837
# Could well be another local process by a different user, but
838
# just to be safe we won't conclude about this either.
840
pid_str = self.info_dict.get('pid', None)
842
mutter("no pid recorded in %r" % (self, ))
847
mutter("can't parse pid %r from %r"
850
return osutils.is_local_pid_dead(pid)
853
def get_username_for_lock_info():
854
"""Get a username suitable for putting into a lock.
856
It's ok if what's written here is not a proper email address as long
857
as it gives some clue who the user is.
860
return config.GlobalConfig().username()
861
except errors.NoWhoami:
862
return osutils.getuser_unicode()
added
removed
bzrlib/lockdir.py
