226
239
except (errors.TransportError, PathError), e:
227
240
self._trace("... failed to create pending dir, %s", e)
228
241
raise LockFailed(self, e)
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)
244
self.transport.rename(tmpname, self._held_dir)
246
except (errors.TransportError, PathError, DirectoryNotEmpty,
247
FileExists, ResourceBusy), e:
248
self._trace("... contention, %s", e)
249
other_holder = self.peek()
250
self._trace("other holder is %r" % other_holder)
252
self._handle_lock_contention(other_holder)
254
self._remove_pending_dir(tmpname)
257
self._trace("... lock failed, %s", e)
258
self._remove_pending_dir(tmpname)
240
260
# We must check we really got the lock, because Launchpad's sftp
241
261
# server at one time had a bug were the rename would successfully
242
262
# move the new directory into the existing directory, which was
262
282
(time.time() - start_time) * 1000)
263
283
return self.nonce
285
def _handle_lock_contention(self, other_holder):
286
"""A lock we want to take is held by someone else.
288
This function can: tell the user about it; possibly detect that it's
289
safe or appropriate to steal the lock, or just raise an exception.
291
If this function returns (without raising an exception) the lock will
294
:param other_holder: A LockHeldInfo for the current holder; note that
295
it might be None if the lock can be seen to be held but the info
298
if (other_holder is not None):
299
if other_holder.is_lock_holder_known_dead():
300
if self.get_config().get('locks.steal_dead'):
301
ui.ui_factory.show_user_warning(
303
lock_url=urlutils.join(self.transport.base, self.path),
304
other_holder_info=unicode(other_holder))
305
self.force_break(other_holder)
306
self._trace("stole lock from dead holder")
308
raise LockContention(self)
265
310
def _remove_pending_dir(self, tmpname):
266
311
"""Remove the pending directory
355
401
holder_info = self.peek()
356
402
except LockCorrupt, e:
357
403
# The lock info is corrupt.
358
if bzrlib.ui.ui_factory.get_boolean("Break (corrupt %r)" % (self,)):
404
if ui.ui_factory.get_boolean(u"Break (corrupt %r)" % (self,)):
359
405
self.force_break_corrupt(e.file_data)
361
407
if holder_info is not None:
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)):
408
if ui.ui_factory.confirm_action(
409
u"Break %(lock_info)s",
410
'bzrlib.lockdir.break',
411
dict(lock_info=unicode(holder_info))):
366
412
result = self.force_break(holder_info)
367
bzrlib.ui.ui_factory.show_message(
413
ui.ui_factory.show_message(
368
414
"Broke lock %s" % result.lock_url)
370
416
def force_break(self, dead_holder_info):
374
420
it still thinks it has the lock there will be two concurrent writers.
375
421
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.
382
423
After the lock is broken it will not be held by any process.
383
424
It is possible that another process may sneak in and take the
384
425
lock before the breaking process acquires it.
427
:param dead_holder_info:
428
Must be the result of a previous LockDir.peek() call; this is used
429
to check that it's still held by the same process that the user
430
decided was dead. If this is not the current holder,
431
LockBreakMismatch is raised.
386
433
:returns: LockResult for the broken lock.
388
if not isinstance(dead_holder_info, dict):
435
if not isinstance(dead_holder_info, LockHeldInfo):
389
436
raise ValueError("dead_holder_info: %r" % dead_holder_info)
390
437
self._check_not_locked()
391
438
current_info = self.peek()
489
537
def _prepare_info(self):
490
538
"""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()
522
541
def attempt_lock(self):
523
542
"""Take the lock; fail if it's already held.
582
613
new_info = self.peek()
583
614
if new_info is not None and new_info != last_info:
584
615
if last_info is None:
585
start = 'Unable to obtain'
616
start = gettext('Unable to obtain')
587
start = 'Lock owner changed for'
618
start = gettext('Lock owner changed for')
588
619
last_info = new_info
589
formatted_info = self._format_lock_info(new_info)
620
msg = gettext('{0} lock {1} {2}.').format(start, lock_url,
590
622
if deadline_str is None:
591
623
deadline_str = time.strftime('%H:%M:%S',
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]
624
time.localtime(deadline))
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)
626
msg += '\n' + gettext(
627
'Will continue to try until %s, unless '
628
'you press Ctrl-C.') % deadline_str
629
msg += '\n' + gettext('See "bzr help break-lock" for more.')
630
self._report_function(msg)
614
631
if (max_attempts is not None) and (attempt_count >= max_attempts):
615
632
self._trace("exceeded %d attempts")
616
633
raise LockContention(self)
705
705
if 'lock' not in debug.debug_flags:
707
707
mutter(str(self) + ": " + (format % args))
709
def get_config(self):
710
"""Get the configuration that governs this lockdir."""
711
# XXX: This really should also use the locationconfig at least, but
712
# that seems a bit hard to hook up at the moment. -- mbp 20110329
713
# FIXME: The above is still true ;) -- vila 20110811
714
return config.GlobalStack()
717
class LockHeldInfo(object):
718
"""The information recorded about a held lock.
720
This information is recorded into the lock when it's taken, and it can be
721
read back by any process with access to the lockdir. It can be used, for
722
example, to tell the user who holds the lock, or to try to detect whether
723
the lock holder is still alive.
725
Prior to bzr 2.4 a simple dict was used instead of an object.
728
def __init__(self, info_dict):
729
self.info_dict = info_dict
732
"""Return a debugging representation of this object."""
733
return "%s(%r)" % (self.__class__.__name__, self.info_dict)
735
def __unicode__(self):
736
"""Return a user-oriented description of this object."""
737
d = self.to_readable_dict()
739
u'held by %(user)s on %(hostname)s (process #%(pid)s), '
740
u'acquired %(time_ago)s') % d)
742
def to_readable_dict(self):
743
"""Turn the holder info into a dict of human-readable attributes.
745
For example, the start time is presented relative to the current time,
746
rather than as seconds since the epoch.
748
Returns a list of [user, hostname, pid, time_ago] all as readable
751
start_time = self.info_dict.get('start_time')
752
if start_time is None:
753
time_ago = '(unknown)'
755
time_ago = format_delta(
756
time.time() - int(self.info_dict['start_time']))
757
user = self.info_dict.get('user', '<unknown>')
758
hostname = self.info_dict.get('hostname', '<unknown>')
759
pid = self.info_dict.get('pid', '<unknown>')
766
def get(self, field_name):
767
"""Return the contents of a field from the lock info, or None."""
768
return self.info_dict.get(field_name)
771
def for_this_process(cls, extra_holder_info):
772
"""Return a new LockHeldInfo for a lock taken by this process.
775
hostname=get_host_name(),
776
pid=str(os.getpid()),
777
nonce=rand_chars(20),
778
start_time=str(int(time.time())),
779
user=get_username_for_lock_info(),
781
if extra_holder_info is not None:
782
info.update(extra_holder_info)
786
s = rio.Stanza(**self.info_dict)
790
def from_info_file_bytes(cls, info_file_bytes):
791
"""Construct from the contents of the held file."""
792
lines = osutils.split_lines(info_file_bytes)
794
stanza = rio.read_stanza(lines)
795
except ValueError, e:
796
mutter('Corrupt lock info file: %r', lines)
797
raise LockCorrupt("could not parse lock info file: " + str(e),
800
# see bug 185013; we fairly often end up with the info file being
801
# empty after an interruption; we could log a message here but
802
# there may not be much we can say
805
return cls(stanza.as_dict())
807
def __cmp__(self, other):
808
"""Value comparison of lock holders."""
810
cmp(type(self), type(other))
811
or cmp(self.info_dict, other.info_dict))
813
def is_locked_by_this_process(self):
814
"""True if this process seems to be the current lock holder."""
816
self.get('hostname') == get_host_name()
817
and self.get('pid') == str(os.getpid())
818
and self.get('user') == get_username_for_lock_info())
820
def is_lock_holder_known_dead(self):
821
"""True if the lock holder process is known to be dead.
823
False if it's either known to be still alive, or if we just can't tell.
825
We can be fairly sure the lock holder is dead if it declared the same
826
hostname and there is no process with the given pid alive. If people
827
have multiple machines with the same hostname this may cause trouble.
829
This doesn't check whether the lock holder is in fact the same process
830
calling this method. (In that case it will return true.)
832
if self.get('hostname') != get_host_name():
834
if self.get('hostname') == 'localhost':
837
if self.get('user') != get_username_for_lock_info():
838
# Could well be another local process by a different user, but
839
# just to be safe we won't conclude about this either.
841
pid_str = self.info_dict.get('pid', None)
843
mutter("no pid recorded in %r" % (self, ))
848
mutter("can't parse pid %r from %r"
851
return osutils.is_local_pid_dead(pid)
854
def get_username_for_lock_info():
855
"""Get a username suitable for putting into a lock.
857
It's ok if what's written here is not a proper email address as long
858
as it gives some clue who the user is.
861
return config.GlobalStack().get('email')
862
except errors.NoWhoami:
863
return osutils.getuser_unicode()
added
removed
bzrlib/lockdir.py
