1
# Copyright (C) 2006-2011 Canonical Ltd
1
# Copyright (C) 2006 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""On-disk mutex protecting a resource
88
88
>>> t = MemoryTransport()
89
89
>>> l = LockDir(t, 'sample-lock')
91
>>> token = l.wait_lock()
92
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
99
from warnings import warn
100
from StringIO import StringIO
115
102
import bzrlib.config
116
from bzrlib.decorators import only_raises
117
103
from bzrlib.errors import (
118
104
DirectoryNotEmpty,
120
106
LockBreakMismatch,
131
from bzrlib.trace import mutter, note
132
from bzrlib.osutils import format_delta, rand_chars, get_host_name
135
from bzrlib.lazy_import import lazy_import
136
lazy_import(globals(), """
137
from bzrlib import rio
116
from bzrlib.trace import mutter
117
from bzrlib.transport import Transport
118
from bzrlib.osutils import rand_chars
119
from bzrlib.rio import RioWriter, read_stanza, Stanza
140
121
# XXX: At the moment there is no consideration of thread safety on LockDir
141
122
# objects. This should perhaps be updated - e.g. if two threads try to take a
142
123
# lock at the same time they should *both* get it. But then that's unlikely
143
124
# to be a good idea.
126
# TODO: Transport could offer a simpler put() method that avoids the
127
# rename-into-place for cases like creating the lock template, where there is
128
# no chance that the file already exists.
145
130
# TODO: Perhaps store some kind of note like the bzr command line in the lock
194
176
def create(self, mode=None):
195
177
"""Create the on-disk lock.
197
This is typically only called when the object/directory containing the
179
This is typically only called when the object/directory containing the
198
180
directory is first created. The lock is not held when it's created.
200
self._trace("create lock directory")
202
self.transport.mkdir(self.path, mode=mode)
203
except (TransportError, PathError), e:
204
raise LockFailed(self, e)
207
def _attempt_lock(self):
208
"""Make the pending directory and attempt to rename into place.
210
If the rename succeeds, we read back the info file to check that we
213
If we fail to acquire the lock, this method is responsible for
214
cleaning up the pending directory if possible. (But it doesn't do
217
:returns: The nonce of the lock, if it was successfully acquired.
219
:raises LockContention: If the lock is held by someone else. The exception
220
contains the info of the current holder of the lock.
182
if self.transport.is_readonly():
183
raise UnlockableTransport(self.transport)
184
self.transport.mkdir(self.path, mode=mode)
186
def attempt_lock(self):
187
"""Take the lock; fail if it's already held.
189
If you wish to block until the lock can be obtained, call wait_lock()
222
self._trace("lock_write...")
223
start_time = time.time()
225
tmpname = self._create_pending_dir()
226
except (errors.TransportError, PathError), e:
227
self._trace("... failed to create pending dir, %s", e)
228
raise LockFailed(self, e)
192
if self._fake_read_lock:
193
raise LockContention(self)
194
if self.transport.is_readonly():
195
raise UnlockableTransport(self.transport)
197
tmpname = '%s/pending.%s.tmp' % (self.path, rand_chars(20))
198
self.transport.mkdir(tmpname)
200
self._prepare_info(sio)
202
self.transport.put(tmpname + self.__INFO_NAME, sio)
230
203
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)
240
# We must check we really got the lock, because Launchpad's sftp
241
# server at one time had a bug were the rename would successfully
242
# move the new directory into the existing directory, which was
243
# incorrect. It's possible some other servers or filesystems will
244
# have a similar bug allowing someone to think they got the lock
245
# when it's already held.
247
# See <https://bugs.launchpad.net/bzr/+bug/498378> for one case.
249
# Strictly the check is unnecessary and a waste of time for most
250
# people, but probably worth trapping if something is wrong.
252
self._trace("after locking, info=%r", info)
254
raise LockFailed(self, "lock was renamed into place, but "
256
if info.get('nonce') != self.nonce:
257
self._trace("rename succeeded, "
258
"but lock is still held by someone else")
259
raise LockContention(self)
260
self._lock_held = True
261
self._trace("... lock succeeded after %dms",
262
(time.time() - start_time) * 1000)
265
def _remove_pending_dir(self, tmpname):
266
"""Remove the pending directory
268
This is called if we failed to rename into place, so that the pending
269
dirs don't clutter up the lockdir.
271
self._trace("remove %s", tmpname)
273
self.transport.delete(tmpname + self.__INFO_NAME)
274
self.transport.rmdir(tmpname)
276
note("error removing pending lock: %s", e)
278
def _create_pending_dir(self):
279
tmpname = '%s/%s.tmp' % (self.path, rand_chars(10))
281
self.transport.mkdir(tmpname)
283
# This may raise a FileExists exception
284
# which is okay, it will be caught later and determined
285
# to be a LockContention.
286
self._trace("lock directory does not exist, creating it")
287
self.create(mode=self._dir_modebits)
288
# After creating the lock directory, try again
289
self.transport.mkdir(tmpname)
290
self.nonce = rand_chars(20)
291
info_bytes = self._prepare_info()
292
# We use put_file_non_atomic because we just created a new unique
293
# directory so we don't have to worry about files existing there.
294
# We'll rename the whole directory into place to get atomic
296
self.transport.put_bytes_non_atomic(tmpname + self.__INFO_NAME,
300
@only_raises(LockNotHeld, LockBroken)
204
self._lock_held = True
206
except (PathError, DirectoryNotEmpty, FileExists, ResourceBusy), e:
207
mutter("contention on %r: %s", self, e)
208
raise LockContention(self)
301
210
def unlock(self):
302
211
"""Release a held lock
305
214
self._fake_read_lock = False
307
216
if not self._lock_held:
308
return lock.cant_unlock_not_held(self)
309
if self._locked_via_token:
310
self._locked_via_token = False
311
self._lock_held = False
313
old_nonce = self.nonce
314
# rename before deleting, because we can't atomically remove the
316
start_time = time.time()
317
self._trace("unlocking")
318
tmpname = '%s/releasing.%s.tmp' % (self.path, rand_chars(20))
319
# gotta own it to unlock
321
self.transport.rename(self._held_dir, tmpname)
322
self._lock_held = False
323
self.transport.delete(tmpname + self.__INFO_NAME)
325
self.transport.rmdir(tmpname)
326
except DirectoryNotEmpty, e:
327
# There might have been junk left over by a rename that moved
328
# another locker within the 'held' directory. do a slower
329
# deletion where we list the directory and remove everything
332
# Maybe this should be broader to allow for ftp servers with
333
# non-specific error messages?
334
self._trace("doing recursive deletion of non-empty directory "
336
self.transport.delete_tree(tmpname)
337
self._trace("... unlock succeeded after %dms",
338
(time.time() - start_time) * 1000)
339
result = lock.LockResult(self.transport.abspath(self.path),
341
for hook in self.hooks['lock_released']:
344
def break_lock(self):
345
"""Break a lock not held by this instance of LockDir.
347
This is a UI centric function: it uses the bzrlib.ui.ui_factory to
348
prompt for input if a lock is detected and there is any doubt about
349
it possibly being still active.
351
:returns: LockResult for the broken lock.
353
self._check_not_locked()
355
holder_info = self.peek()
356
except LockCorrupt, e:
357
# The lock info is corrupt.
358
if bzrlib.ui.ui_factory.get_boolean(u"Break (corrupt %r)" % (self,)):
359
self.force_break_corrupt(e.file_data)
361
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)):
366
result = self.force_break(holder_info)
367
bzrlib.ui.ui_factory.show_message(
368
"Broke lock %s" % result.lock_url)
217
raise LockNotHeld(self)
218
# rename before deleting, because we can't atomically remove the whole
220
tmpname = '%s/releasing.%s.tmp' % (self.path, rand_chars(20))
221
self.transport.rename(self._held_dir, tmpname)
222
self._lock_held = False
223
self.transport.delete(tmpname + self.__INFO_NAME)
224
self.transport.rmdir(tmpname)
370
226
def force_break(self, dead_holder_info):
371
227
"""Release a lock held by another process.
405
260
raise LockBreakMismatch(self, broken_info, dead_holder_info)
406
261
self.transport.delete(broken_info_path)
407
262
self.transport.rmdir(tmpname)
408
result = lock.LockResult(self.transport.abspath(self.path),
409
current_info.get('nonce'))
410
for hook in self.hooks['lock_broken']:
414
def force_break_corrupt(self, corrupt_info_lines):
415
"""Release a lock that has been corrupted.
417
This is very similar to force_break, it except it doesn't assume that
418
self.peek() can work.
420
:param corrupt_info_lines: the lines of the corrupted info file, used
421
to check that the lock hasn't changed between reading the (corrupt)
422
info file and calling force_break_corrupt.
424
# XXX: this copes with unparseable info files, but what about missing
425
# info files? Or missing lock dirs?
426
self._check_not_locked()
427
tmpname = '%s/broken.%s.tmp' % (self.path, rand_chars(20))
428
self.transport.rename(self._held_dir, tmpname)
429
# check that we actually broke the right lock, not someone else;
430
# there's a small race window between checking it and doing the
432
broken_info_path = tmpname + self.__INFO_NAME
433
broken_content = self.transport.get_bytes(broken_info_path)
434
broken_lines = osutils.split_lines(broken_content)
435
if broken_lines != corrupt_info_lines:
436
raise LockBreakMismatch(self, broken_lines, corrupt_info_lines)
437
self.transport.delete(broken_info_path)
438
self.transport.rmdir(tmpname)
439
result = lock.LockResult(self.transport.abspath(self.path))
440
for hook in self.hooks['lock_broken']:
443
def _check_not_locked(self):
444
"""If the lock is held by this instance, raise an error."""
446
raise AssertionError("can't break own lock: %r" % self)
448
264
def confirm(self):
449
265
"""Make sure that the lock is still held by this locker.
464
280
if info.get('nonce') != self.nonce:
465
281
# there is a lock, but not ours
466
282
raise LockBroken(self)
468
284
def _read_info_file(self, path):
469
285
"""Read one given info file.
471
287
peek() reads the info file of the lock holder, if any.
473
return self._parse_info(self.transport.get_bytes(path))
289
return self._parse_info(self.transport.get(path))
476
292
"""Check if the lock is held by anyone.
478
If it is held, this returns the lock info structure as a dict
294
If it is held, this returns the lock info structure as a rio Stanza,
479
295
which contains some information about the current lock holder.
480
296
Otherwise returns None.
483
299
info = self._read_info_file(self._held_info_path)
484
self._trace("peek -> held")
300
assert isinstance(info, dict), \
301
"bad parse result %r" % info
486
303
except NoSuchFile, e:
487
self._trace("peek -> not held")
489
def _prepare_info(self):
306
def _prepare_info(self, outf):
490
307
"""Write information about a pending lock to a temporary file.
492
310
# XXX: is creating this here inefficient?
493
311
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(),
312
s = Stanza(hostname=socket.gethostname(),
499
313
pid=str(os.getpid()),
500
314
start_time=str(int(time.time())),
501
315
nonce=self.nonce,
316
user=config.user_email(),
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
def attempt_lock(self):
523
"""Take the lock; fail if it's already held.
525
If you wish to block until the lock can be obtained, call wait_lock()
528
:return: The lock token.
529
:raises LockContention: if the lock is held by someone else.
531
if self._fake_read_lock:
532
raise LockContention(self)
533
result = self._attempt_lock()
534
hook_result = lock.LockResult(self.transport.abspath(self.path),
536
for hook in self.hooks['lock_acquired']:
540
def lock_url_for_display(self):
541
"""Give a nicely-printable representation of the URL of this lock."""
542
# As local lock urls are correct we display them.
543
# We avoid displaying remote lock urls.
544
lock_url = self.transport.abspath(self.path)
545
if lock_url.startswith('file://'):
546
lock_url = lock_url.split('.bzr/')[0]
551
def wait_lock(self, timeout=None, poll=None, max_attempts=None):
318
RioWriter(outf).write_stanza(s)
320
def _parse_info(self, info_file):
321
return read_stanza(info_file.readlines()).as_dict()
323
def wait_lock(self, timeout=_DEFAULT_TIMEOUT_SECONDS,
324
poll=_DEFAULT_POLL_SECONDS):
552
325
"""Wait a certain period for a lock.
554
327
If the lock can be acquired within the bounded time, it
556
329
is raised. Either way, this function should return within
557
330
approximately `timeout` seconds. (It may be a bit more if
558
331
a transport operation takes a long time to complete.)
560
:param timeout: Approximate maximum amount of time to wait for the
563
:param poll: Delay in seconds between retrying the lock.
565
:param max_attempts: Maximum number of times to try to lock.
567
:return: The lock token.
570
timeout = _DEFAULT_TIMEOUT_SECONDS
572
poll = _DEFAULT_POLL_SECONDS
573
# XXX: the transport interface doesn't let us guard against operations
574
# there taking a long time, so the total elapsed time or poll interval
575
# may be more than was requested.
333
# XXX: the transport interface doesn't let us guard
334
# against operations there taking a long time.
576
335
deadline = time.time() + timeout
580
lock_url = self.lock_url_for_display()
584
return self.attempt_lock()
585
340
except LockContention:
586
# possibly report the blockage, then try again
588
# TODO: In a few cases, we find out that there's contention by
589
# reading the held info and observing that it's not ours. In
590
# those cases it's a bit redundant to read it again. However,
591
# the normal case (??) is that the rename fails and so we
592
# don't know who holds the lock. For simplicity we peek
594
new_info = self.peek()
595
if new_info is not None and new_info != last_info:
596
if last_info is None:
597
start = 'Unable to obtain'
599
start = 'Lock owner changed for'
601
formatted_info = self._format_lock_info(new_info)
602
if deadline_str is None:
603
deadline_str = time.strftime('%H:%M:%S',
604
time.localtime(deadline))
605
user, hostname, pid, time_ago = formatted_info
606
msg = ('%s lock %s ' # lock_url
610
'[process #%s], ' # pid
611
'acquired %s.') # time ago
612
msg_args = [start, lock_url, user, hostname, pid, time_ago]
614
msg += ('\nWill continue to try until %s, unless '
616
msg_args.append(deadline_str)
617
msg += '\nSee "bzr help break-lock" for more.'
618
self._report_function(msg, *msg_args)
619
if (max_attempts is not None) and (attempt_count >= max_attempts):
620
self._trace("exceeded %d attempts")
621
raise LockContention(self)
622
342
if time.time() + poll < deadline:
623
self._trace("waiting %ss", poll)
626
# As timeout is always 0 for remote locks
627
# this block is applicable only for local
629
self._trace("timeout after waiting %ss", timeout)
630
raise LockContention('(local)', lock_url)
632
def leave_in_place(self):
633
self._locked_via_token = True
635
def dont_leave_in_place(self):
636
self._locked_via_token = False
638
def lock_write(self, token=None):
639
"""Wait for and acquire the lock.
641
:param token: if this is already locked, then lock_write will fail
642
unless the token matches the existing lock.
643
:returns: a token if this instance supports tokens, otherwise None.
644
:raises TokenLockingNotSupported: when a token is given but this
645
instance doesn't support using token locks.
646
:raises MismatchedToken: if the specified token doesn't match the token
647
of the existing lock.
649
A token should be passed in if you know that you have locked the object
650
some other way, and need to synchronise this object's state with that
653
XXX: docstring duplicated from LockableFiles.lock_write.
655
if token is not None:
656
self.validate_token(token)
658
self._lock_held = True
659
self._locked_via_token = True
662
return self.wait_lock()
345
raise LockContention(self)
347
def lock_write(self):
348
"""Wait for and acquire the lock."""
664
351
def lock_read(self):
665
"""Compatibility-mode shared lock.
352
"""Compatability-mode shared lock.
667
LockDir doesn't support shared read-only locks, so this
354
LockDir doesn't support shared read-only locks, so this
668
355
just pretends that the lock is taken but really does nothing.
670
# At the moment Branches are commonly locked for read, but
357
# At the moment Branches are commonly locked for read, but
671
358
# we can't rely on that remotely. Once this is cleaned up,
672
# reenable this warning to prevent it coming back in
359
# reenable this warning to prevent it coming back in
673
360
# -- mbp 20060303
674
361
## warn("LockDir.lock_read falls back to write lock")
675
362
if self._lock_held or self._fake_read_lock:
676
363
raise LockContention(self)
677
364
self._fake_read_lock = True
679
def _format_lock_info(self, info):
680
"""Turn the contents of peek() into something for the user"""
681
start_time = info.get('start_time')
682
if start_time is None:
683
time_ago = '(unknown)'
685
time_ago = format_delta(time.time() - int(info['start_time']))
686
user = info.get('user', '<unknown>')
687
hostname = info.get('hostname', '<unknown>')
688
pid = info.get('pid', '<unknown>')
696
def validate_token(self, token):
697
if token is not None:
703
lock_token = info.get('nonce')
704
if token != lock_token:
705
raise errors.TokenMismatch(token, lock_token)
707
self._trace("revalidated by token %r", token)
709
def _trace(self, format, *args):
710
if 'lock' not in debug.debug_flags:
712
mutter(str(self) + ": " + (format % args))
366
def wait(self, timeout=20, poll=0.5):
367
"""Wait a certain period for a lock to be released."""
368
# XXX: the transport interface doesn't let us guard
369
# against operations there taking a long time.
370
deadline = time.time() + timeout
374
if time.time() + poll < deadline:
377
raise LockContention(self)
added
removed
bzrlib/lockdir.py
