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 cStringIO import StringIO
109
101
from bzrlib import (
115
104
import bzrlib.config
116
from bzrlib.decorators import only_raises
117
105
from bzrlib.errors import (
118
106
DirectoryNotEmpty,
120
108
LockBreakMismatch,
130
117
from bzrlib.trace import mutter, note
131
from bzrlib.osutils import format_delta, rand_chars, get_host_name
118
from bzrlib.transport import Transport
119
from bzrlib.osutils import rand_chars, format_delta
120
from bzrlib.rio import read_stanza, Stanza
134
from bzrlib.lazy_import import lazy_import
135
lazy_import(globals(), """
136
from bzrlib import rio
139
124
# XXX: At the moment there is no consideration of thread safety on LockDir
140
125
# objects. This should perhaps be updated - e.g. if two threads try to take a
193
179
def create(self, mode=None):
194
180
"""Create the on-disk lock.
196
This is typically only called when the object/directory containing the
182
This is typically only called when the object/directory containing the
197
183
directory is first created. The lock is not held when it's created.
199
self._trace("create lock directory")
201
self.transport.mkdir(self.path, mode=mode)
202
except (TransportError, PathError), e:
203
raise LockFailed(self, e)
206
def _attempt_lock(self):
207
"""Make the pending directory and attempt to rename into place.
209
If the rename succeeds, we read back the info file to check that we
212
If we fail to acquire the lock, this method is responsible for
213
cleaning up the pending directory if possible. (But it doesn't do
216
:returns: The nonce of the lock, if it was successfully acquired.
218
:raises LockContention: If the lock is held by someone else. The exception
219
contains the info of the current holder of the lock.
185
if self.transport.is_readonly():
186
raise UnlockableTransport(self.transport)
187
self.transport.mkdir(self.path, mode=mode)
189
def attempt_lock(self):
190
"""Take the lock; fail if it's already held.
192
If you wish to block until the lock can be obtained, call wait_lock()
221
self._trace("lock_write...")
222
start_time = time.time()
224
tmpname = self._create_pending_dir()
225
except (errors.TransportError, PathError), e:
226
self._trace("... failed to create pending dir, %s", e)
227
raise LockFailed(self, e)
195
if self._fake_read_lock:
196
raise LockContention(self)
197
if self.transport.is_readonly():
198
raise UnlockableTransport(self.transport)
200
tmpname = '%s/pending.%s.tmp' % (self.path, rand_chars(20))
202
self.transport.mkdir(tmpname)
204
# This may raise a FileExists exception
205
# which is okay, it will be caught later and determined
206
# to be a LockContention.
207
self.create(mode=self._dir_modebits)
209
# After creating the lock directory, try again
210
self.transport.mkdir(tmpname)
212
self.nonce = rand_chars(20)
213
info_bytes = self._prepare_info()
214
# We use put_file_non_atomic because we just created a new unique
215
# directory so we don't have to worry about files existing there.
216
# We'll rename the whole directory into place to get atomic
218
self.transport.put_bytes_non_atomic(tmpname + self.__INFO_NAME,
229
221
self.transport.rename(tmpname, self._held_dir)
230
except (errors.TransportError, PathError, DirectoryNotEmpty,
231
FileExists, ResourceBusy), e:
232
self._trace("... contention, %s", e)
233
self._remove_pending_dir(tmpname)
234
raise LockContention(self)
236
self._trace("... lock failed, %s", e)
237
self._remove_pending_dir(tmpname)
222
self._lock_held = True
224
except errors.PermissionDenied:
239
# We must check we really got the lock, because Launchpad's sftp
240
# server at one time had a bug were the rename would successfully
241
# move the new directory into the existing directory, which was
242
# incorrect. It's possible some other servers or filesystems will
243
# have a similar bug allowing someone to think they got the lock
244
# when it's already held.
246
# See <https://bugs.edge.launchpad.net/bzr/+bug/498378> for one case.
248
# Strictly the check is unnecessary and a waste of time for most
249
# people, but probably worth trapping if something is wrong.
251
self._trace("after locking, info=%r", info)
253
raise LockFailed(self, "lock was renamed into place, but "
255
if info['nonce'] != self.nonce:
256
self._trace("rename succeeded, "
257
"but lock is still held by someone else")
226
except (PathError, DirectoryNotEmpty, FileExists, ResourceBusy), e:
227
mutter("contention on %r: %s", self, e)
258
228
raise LockContention(self)
259
self._lock_held = True
260
self._trace("... lock succeeded after %dms",
261
(time.time() - start_time) * 1000)
264
def _remove_pending_dir(self, tmpname):
265
"""Remove the pending directory
267
This is called if we failed to rename into place, so that the pending
268
dirs don't clutter up the lockdir.
270
self._trace("remove %s", tmpname)
272
self.transport.delete(tmpname + self.__INFO_NAME)
273
self.transport.rmdir(tmpname)
275
note("error removing pending lock: %s", e)
277
def _create_pending_dir(self):
278
tmpname = '%s/%s.tmp' % (self.path, rand_chars(10))
280
self.transport.mkdir(tmpname)
282
# This may raise a FileExists exception
283
# which is okay, it will be caught later and determined
284
# to be a LockContention.
285
self._trace("lock directory does not exist, creating it")
286
self.create(mode=self._dir_modebits)
287
# After creating the lock directory, try again
288
self.transport.mkdir(tmpname)
289
self.nonce = rand_chars(20)
290
info_bytes = self._prepare_info()
291
# We use put_file_non_atomic because we just created a new unique
292
# directory so we don't have to worry about files existing there.
293
# We'll rename the whole directory into place to get atomic
295
self.transport.put_bytes_non_atomic(tmpname + self.__INFO_NAME,
299
@only_raises(LockNotHeld, LockBroken)
300
230
def unlock(self):
301
231
"""Release a held lock
304
234
self._fake_read_lock = False
306
236
if not self._lock_held:
307
return lock.cant_unlock_not_held(self)
237
raise LockNotHeld(self)
308
238
if self._locked_via_token:
309
239
self._locked_via_token = False
310
240
self._lock_held = False
312
old_nonce = self.nonce
313
242
# rename before deleting, because we can't atomically remove the
315
start_time = time.time()
316
self._trace("unlocking")
317
244
tmpname = '%s/releasing.%s.tmp' % (self.path, rand_chars(20))
318
245
# gotta own it to unlock
320
247
self.transport.rename(self._held_dir, tmpname)
321
248
self._lock_held = False
322
249
self.transport.delete(tmpname + self.__INFO_NAME)
324
self.transport.rmdir(tmpname)
325
except DirectoryNotEmpty, e:
326
# There might have been junk left over by a rename that moved
327
# another locker within the 'held' directory. do a slower
328
# deletion where we list the directory and remove everything
331
# Maybe this should be broader to allow for ftp servers with
332
# non-specific error messages?
333
self._trace("doing recursive deletion of non-empty directory "
335
self.transport.delete_tree(tmpname)
336
self._trace("... unlock succeeded after %dms",
337
(time.time() - start_time) * 1000)
338
result = lock.LockResult(self.transport.abspath(self.path),
340
for hook in self.hooks['lock_released']:
250
self.transport.rmdir(tmpname)
343
252
def break_lock(self):
344
253
"""Break a lock not held by this instance of LockDir.
419
324
if info.get('nonce') != self.nonce:
420
325
# there is a lock, but not ours
421
326
raise LockBroken(self)
423
328
def _read_info_file(self, path):
424
329
"""Read one given info file.
426
331
peek() reads the info file of the lock holder, if any.
428
return self._parse_info(self.transport.get_bytes(path))
333
return self._parse_info(self.transport.get(path))
431
336
"""Check if the lock is held by anyone.
433
338
If it is held, this returns the lock info structure as a rio Stanza,
434
339
which contains some information about the current lock holder.
435
340
Otherwise returns None.
438
343
info = self._read_info_file(self._held_info_path)
439
self._trace("peek -> held")
344
assert isinstance(info, dict), \
345
"bad parse result %r" % info
441
347
except NoSuchFile, e:
442
self._trace("peek -> not held")
444
350
def _prepare_info(self):
445
351
"""Write information about a pending lock to a temporary file.
447
354
# XXX: is creating this here inefficient?
448
355
config = bzrlib.config.GlobalConfig()
450
357
user = config.user_email()
451
358
except errors.NoEmailInUsername:
452
359
user = config.username()
453
s = rio.Stanza(hostname=get_host_name(),
360
s = Stanza(hostname=socket.gethostname(),
454
361
pid=str(os.getpid()),
455
362
start_time=str(int(time.time())),
456
363
nonce=self.nonce,
488
376
is raised. Either way, this function should return within
489
377
approximately `timeout` seconds. (It may be a bit more if
490
378
a transport operation takes a long time to complete.)
492
:param timeout: Approximate maximum amount of time to wait for the
495
:param poll: Delay in seconds between retrying the lock.
497
:param max_attempts: Maximum number of times to try to lock.
499
:return: The lock token.
501
380
if timeout is None:
502
381
timeout = _DEFAULT_TIMEOUT_SECONDS
504
383
poll = _DEFAULT_POLL_SECONDS
505
# XXX: the transport interface doesn't let us guard against operations
506
# there taking a long time, so the total elapsed time or poll interval
507
# may be more than was requested.
385
# XXX: the transport interface doesn't let us guard
386
# against operations there taking a long time.
508
387
deadline = time.time() + timeout
509
388
deadline_str = None
515
return self.attempt_lock()
516
394
except LockContention:
517
# possibly report the blockage, then try again
519
# TODO: In a few cases, we find out that there's contention by
520
# reading the held info and observing that it's not ours. In
521
# those cases it's a bit redundant to read it again. However,
522
# the normal case (??) is that the rename fails and so we
523
# don't know who holds the lock. For simplicity we peek
525
396
new_info = self.peek()
397
mutter('last_info: %s, new info: %s', last_info, new_info)
526
398
if new_info is not None and new_info != last_info:
527
399
if last_info is None:
528
400
start = 'Unable to obtain'
533
405
if deadline_str is None:
534
406
deadline_str = time.strftime('%H:%M:%S',
535
407
time.localtime(deadline))
536
lock_url = self.transport.abspath(self.path)
537
# See <https://bugs.edge.launchpad.net/bzr/+bug/250451>
538
# the URL here is sometimes not one that is useful to the
539
# user, perhaps being wrapped in a lp-%d or chroot decorator,
540
# especially if this error is issued from the server.
541
408
self._report_function('%s %s\n'
543
'%s\n' # locked ... ago
544
'Will continue to try until %s, unless '
545
'you press Ctrl-C.\n'
546
'See "bzr help break-lock" for more.',
410
'%s\n' # locked ... ago
411
'Will continue to try until %s\n',
554
if (max_attempts is not None) and (attempt_count >= max_attempts):
555
self._trace("exceeded %d attempts")
556
raise LockContention(self)
557
418
if time.time() + poll < deadline:
558
self._trace("waiting %ss", poll)
561
self._trace("timeout after waiting %ss", timeout)
562
421
raise LockContention(self)
564
423
def leave_in_place(self):
565
424
self._locked_via_token = True
591
450
self._locked_via_token = True
594
return self.wait_lock()
454
return self.peek().get('nonce')
596
456
def lock_read(self):
597
457
"""Compatibility-mode shared lock.
599
LockDir doesn't support shared read-only locks, so this
459
LockDir doesn't support shared read-only locks, so this
600
460
just pretends that the lock is taken but really does nothing.
602
# At the moment Branches are commonly locked for read, but
462
# At the moment Branches are commonly locked for read, but
603
463
# we can't rely on that remotely. Once this is cleaned up,
604
# reenable this warning to prevent it coming back in
464
# reenable this warning to prevent it coming back in
605
465
# -- mbp 20060303
606
466
## warn("LockDir.lock_read falls back to write lock")
607
467
if self._lock_held or self._fake_read_lock:
608
468
raise LockContention(self)
609
469
self._fake_read_lock = True
471
def wait(self, timeout=20, poll=0.5):
472
"""Wait a certain period for a lock to be released."""
473
# XXX: the transport interface doesn't let us guard
474
# against operations there taking a long time.
475
deadline = time.time() + timeout
479
if time.time() + poll < deadline:
482
raise LockContention(self)
611
484
def _format_lock_info(self, info):
612
485
"""Turn the contents of peek() into something for the user"""
613
486
lock_url = self.transport.abspath(self.path)