179
191
def create(self, mode=None):
180
192
"""Create the on-disk lock.
182
This is typically only called when the object/directory containing the
194
This is typically only called when the object/directory containing the
183
195
directory is first created. The lock is not held when it's created.
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()
197
self._trace("create lock directory")
199
self.transport.mkdir(self.path, mode=mode)
200
except (TransportError, PathError), e:
201
raise LockFailed(self, e)
204
def _attempt_lock(self):
205
"""Make the pending directory and attempt to rename into place.
207
If the rename succeeds, we read back the info file to check that we
210
If we fail to acquire the lock, this method is responsible for
211
cleaning up the pending directory if possible. (But it doesn't do
214
:returns: The nonce of the lock, if it was successfully acquired.
216
:raises LockContention: If the lock is held by someone else. The exception
217
contains the info of the current holder of the lock.
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
info_bytes = self._prepare_info()
213
# We use put_file_non_atomic because we just created a new unique
214
# directory so we don't have to worry about files existing there.
215
# We'll rename the whole directory into place to get atomic
217
self.transport.put_bytes_non_atomic(tmpname + self.__INFO_NAME,
219
self._trace("lock_write...")
220
start_time = time.time()
222
tmpname = self._create_pending_dir()
223
except (errors.TransportError, PathError), e:
224
self._trace("... failed to create pending dir, %s", e)
225
raise LockFailed(self, e)
220
227
self.transport.rename(tmpname, self._held_dir)
221
self._lock_held = True
223
except (PathError, DirectoryNotEmpty, FileExists, ResourceBusy), e:
224
mutter("contention on %r: %s", self, e)
225
raise LockContention(self)
228
except (errors.TransportError, PathError, DirectoryNotEmpty,
229
FileExists, ResourceBusy), e:
230
self._trace("... contention, %s", e)
231
self._remove_pending_dir(tmpname)
232
raise LockContention(self)
234
self._trace("... lock failed, %s", e)
235
self._remove_pending_dir(tmpname)
237
# We must check we really got the lock, because Launchpad's sftp
238
# server at one time had a bug were the rename would successfully
239
# move the new directory into the existing directory, which was
240
# incorrect. It's possible some other servers or filesystems will
241
# have a similar bug allowing someone to think they got the lock
242
# when it's already held.
244
self._trace("after locking, info=%r", info)
245
if info['nonce'] != self.nonce:
246
self._trace("rename succeeded, "
247
"but lock is still held by someone else")
248
raise LockContention(self)
249
self._lock_held = True
250
self._trace("... lock succeeded after %dms",
251
(time.time() - start_time) * 1000)
254
def _remove_pending_dir(self, tmpname):
255
"""Remove the pending directory
257
This is called if we failed to rename into place, so that the pending
258
dirs don't clutter up the lockdir.
260
self._trace("remove %s", tmpname)
262
self.transport.delete(tmpname + self.__INFO_NAME)
263
self.transport.rmdir(tmpname)
265
note("error removing pending lock: %s", e)
267
def _create_pending_dir(self):
268
tmpname = '%s/%s.tmp' % (self.path, rand_chars(10))
270
self.transport.mkdir(tmpname)
272
# This may raise a FileExists exception
273
# which is okay, it will be caught later and determined
274
# to be a LockContention.
275
self._trace("lock directory does not exist, creating it")
276
self.create(mode=self._dir_modebits)
277
# After creating the lock directory, try again
278
self.transport.mkdir(tmpname)
279
self.nonce = rand_chars(20)
280
info_bytes = self._prepare_info()
281
# We use put_file_non_atomic because we just created a new unique
282
# directory so we don't have to worry about files existing there.
283
# We'll rename the whole directory into place to get atomic
285
self.transport.put_bytes_non_atomic(tmpname + self.__INFO_NAME,
227
289
def unlock(self):
228
290
"""Release a held lock
233
295
if not self._lock_held:
234
296
raise LockNotHeld(self)
235
# rename before deleting, because we can't atomically remove the whole
237
tmpname = '%s/releasing.%s.tmp' % (self.path, rand_chars(20))
238
# gotta own it to unlock
240
self.transport.rename(self._held_dir, tmpname)
241
self._lock_held = False
242
self.transport.delete(tmpname + self.__INFO_NAME)
243
self.transport.rmdir(tmpname)
297
if self._locked_via_token:
298
self._locked_via_token = False
299
self._lock_held = False
301
old_nonce = self.nonce
302
# rename before deleting, because we can't atomically remove the
304
start_time = time.time()
305
self._trace("unlocking")
306
tmpname = '%s/releasing.%s.tmp' % (self.path, rand_chars(20))
307
# gotta own it to unlock
309
self.transport.rename(self._held_dir, tmpname)
310
self._lock_held = False
311
self.transport.delete(tmpname + self.__INFO_NAME)
313
self.transport.rmdir(tmpname)
314
except DirectoryNotEmpty, e:
315
# There might have been junk left over by a rename that moved
316
# another locker within the 'held' directory. do a slower
317
# deletion where we list the directory and remove everything
320
# Maybe this should be broader to allow for ftp servers with
321
# non-specific error messages?
322
self._trace("doing recursive deletion of non-empty directory "
324
self.transport.delete_tree(tmpname)
325
self._trace("... unlock succeeded after %dms",
326
(time.time() - start_time) * 1000)
327
result = lock.LockResult(self.transport.abspath(self.path),
329
for hook in self.hooks['lock_released']:
245
332
def break_lock(self):
246
333
"""Break a lock not held by this instance of LockDir.
369
472
is raised. Either way, this function should return within
370
473
approximately `timeout` seconds. (It may be a bit more if
371
474
a transport operation takes a long time to complete.)
476
:param timeout: Approximate maximum amount of time to wait for the
479
:param poll: Delay in seconds between retrying the lock.
481
:param max_attempts: Maximum number of times to try to lock.
483
:return: The lock token.
373
485
if timeout is None:
374
486
timeout = _DEFAULT_TIMEOUT_SECONDS
376
488
poll = _DEFAULT_POLL_SECONDS
378
# XXX: the transport interface doesn't let us guard
379
# against operations there taking a long time.
489
# XXX: the transport interface doesn't let us guard against operations
490
# there taking a long time, so the total elapsed time or poll interval
491
# may be more than was requested.
380
492
deadline = time.time() + timeout
381
493
deadline_str = None
499
return self.attempt_lock()
387
500
except LockContention:
501
# possibly report the blockage, then try again
503
# TODO: In a few cases, we find out that there's contention by
504
# reading the held info and observing that it's not ours. In
505
# those cases it's a bit redundant to read it again. However,
506
# the normal case (??) is that the rename fails and so we
507
# don't know who holds the lock. For simplicity we peek
389
509
new_info = self.peek()
390
mutter('last_info: %s, new info: %s', last_info, new_info)
391
510
if new_info is not None and new_info != last_info:
392
511
if last_info is None:
393
512
start = 'Unable to obtain'
398
517
if deadline_str is None:
399
518
deadline_str = time.strftime('%H:%M:%S',
400
519
time.localtime(deadline))
520
lock_url = self.transport.abspath(self.path)
401
521
self._report_function('%s %s\n'
403
523
'%s\n' # locked ... ago
404
'Will continue to try until %s\n',
524
'Will continue to try until %s, unless '
526
'If you\'re sure that it\'s not being '
527
'modified, use bzr break-lock %s',
406
529
formatted_info[0],
407
530
formatted_info[1],
408
531
formatted_info[2],
535
if (max_attempts is not None) and (attempt_count >= max_attempts):
536
self._trace("exceeded %d attempts")
537
raise LockContention(self)
411
538
if time.time() + poll < deadline:
539
self._trace("waiting %ss", poll)
542
self._trace("timeout after waiting %ss", timeout)
414
543
raise LockContention(self)
416
def lock_write(self):
417
"""Wait for and acquire the lock."""
545
def leave_in_place(self):
546
self._locked_via_token = True
548
def dont_leave_in_place(self):
549
self._locked_via_token = False
551
def lock_write(self, token=None):
552
"""Wait for and acquire the lock.
554
:param token: if this is already locked, then lock_write will fail
555
unless the token matches the existing lock.
556
:returns: a token if this instance supports tokens, otherwise None.
557
:raises TokenLockingNotSupported: when a token is given but this
558
instance doesn't support using token locks.
559
:raises MismatchedToken: if the specified token doesn't match the token
560
of the existing lock.
562
A token should be passed in if you know that you have locked the object
563
some other way, and need to synchronise this object's state with that
566
XXX: docstring duplicated from LockableFiles.lock_write.
568
if token is not None:
569
self.validate_token(token)
571
self._lock_held = True
572
self._locked_via_token = True
575
return self.wait_lock()
420
577
def lock_read(self):
421
578
"""Compatibility-mode shared lock.
423
LockDir doesn't support shared read-only locks, so this
580
LockDir doesn't support shared read-only locks, so this
424
581
just pretends that the lock is taken but really does nothing.
426
# At the moment Branches are commonly locked for read, but
583
# At the moment Branches are commonly locked for read, but
427
584
# we can't rely on that remotely. Once this is cleaned up,
428
# reenable this warning to prevent it coming back in
585
# reenable this warning to prevent it coming back in
429
586
# -- mbp 20060303
430
587
## warn("LockDir.lock_read falls back to write lock")
431
588
if self._lock_held or self._fake_read_lock:
432
589
raise LockContention(self)
433
590
self._fake_read_lock = True
435
def wait(self, timeout=20, poll=0.5):
436
"""Wait a certain period for a lock to be released."""
437
# XXX: the transport interface doesn't let us guard
438
# against operations there taking a long time.
439
deadline = time.time() + timeout
443
if time.time() + poll < deadline:
446
raise LockContention(self)
448
592
def _format_lock_info(self, info):
449
593
"""Turn the contents of peek() into something for the user"""
450
594
lock_url = self.transport.abspath(self.path)