1
# Copyright (C) 2006, 2007 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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
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
108
from cStringIO import StringIO
99
from StringIO import StringIO
114
101
import bzrlib.config
115
102
from bzrlib.errors import (
116
103
DirectoryNotEmpty,
195
176
if self.transport.is_readonly():
196
177
raise UnlockableTransport(self.transport)
197
self._trace("create lock directory")
198
178
self.transport.mkdir(self.path, mode=mode)
200
def _attempt_lock(self):
201
"""Make the pending directory and attempt to rename into place.
180
def attempt_lock(self):
181
"""Take the lock; fail if it's already held.
203
If the rename succeeds, we read back the info file to check that we
206
If we fail to acquire the lock, this method is responsible for
207
cleaning up the pending directory if possible. (But it doesn't do
210
:returns: The nonce of the lock, if it was successfully acquired.
212
:raises LockContention: If the lock is held by someone else. The exception
213
contains the info of the current holder of the lock.
183
If you wish to block until the lock can be obtained, call wait_lock()
215
self._trace("lock_write...")
216
start_time = time.time()
217
tmpname = self._create_pending_dir()
186
if self._fake_read_lock:
187
raise LockContention(self)
188
if self.transport.is_readonly():
189
raise UnlockableTransport(self.transport)
191
tmpname = '%s/pending.%s.tmp' % (self.path, rand_chars(20))
192
self.transport.mkdir(tmpname)
194
self._prepare_info(sio)
196
# append will create a new file; we use append rather than put
197
# because we don't want to write to a temporary file and rename
198
# into place, because that's going to happen to the whole
200
self.transport.append(tmpname + self.__INFO_NAME, sio)
219
201
self.transport.rename(tmpname, self._held_dir)
202
self._lock_held = True
220
204
except (PathError, DirectoryNotEmpty, FileExists, ResourceBusy), e:
221
self._trace("... contention, %s", e)
222
self._remove_pending_dir(tmpname)
223
raise LockContention(self)
225
self._trace("... lock failed, %s", e)
226
self._remove_pending_dir(tmpname)
228
# We must check we really got the lock, because Launchpad's sftp
229
# server at one time had a bug were the rename would successfully
230
# move the new directory into the existing directory, which was
231
# incorrect. It's possible some other servers or filesystems will
232
# have a similar bug allowing someone to think they got the lock
233
# when it's already held.
235
self._trace("after locking, info=%r", info)
236
if info['nonce'] != self.nonce:
237
self._trace("rename succeeded, "
238
"but lock is still held by someone else")
239
raise LockContention(self)
240
self._lock_held = True
241
self._trace("... lock succeeded after %dms",
242
(time.time() - start_time) * 1000)
245
def _remove_pending_dir(self, tmpname):
246
"""Remove the pending directory
248
This is called if we failed to rename into place, so that the pending
249
dirs don't clutter up the lockdir.
251
self._trace("remove %s", tmpname)
253
self.transport.delete(tmpname + self.__INFO_NAME)
254
self.transport.rmdir(tmpname)
256
note("error removing pending lock: %s", e)
258
def _create_pending_dir(self):
259
tmpname = '%s/%s.tmp' % (self.path, rand_chars(10))
261
self.transport.mkdir(tmpname)
263
# This may raise a FileExists exception
264
# which is okay, it will be caught later and determined
265
# to be a LockContention.
266
self._trace("lock directory does not exist, creating it")
267
self.create(mode=self._dir_modebits)
268
# After creating the lock directory, try again
269
self.transport.mkdir(tmpname)
270
self.nonce = rand_chars(20)
271
info_bytes = self._prepare_info()
272
# We use put_file_non_atomic because we just created a new unique
273
# directory so we don't have to worry about files existing there.
274
# We'll rename the whole directory into place to get atomic
276
self.transport.put_bytes_non_atomic(tmpname + self.__INFO_NAME,
205
mutter("contention on %r: %s", self, e)
206
raise LockContention(self)
280
208
def unlock(self):
281
209
"""Release a held lock
286
214
if not self._lock_held:
287
215
raise LockNotHeld(self)
288
if self._locked_via_token:
289
self._locked_via_token = False
290
self._lock_held = False
292
# rename before deleting, because we can't atomically remove the
294
start_time = time.time()
295
self._trace("unlocking")
296
tmpname = '%s/releasing.%s.tmp' % (self.path, rand_chars(20))
297
# gotta own it to unlock
299
self.transport.rename(self._held_dir, tmpname)
300
self._lock_held = False
301
self.transport.delete(tmpname + self.__INFO_NAME)
303
self.transport.rmdir(tmpname)
304
except DirectoryNotEmpty, e:
305
# There might have been junk left over by a rename that moved
306
# another locker within the 'held' directory. do a slower
307
# deletion where we list the directory and remove everything
310
# Maybe this should be broader to allow for ftp servers with
311
# non-specific error messages?
312
self._trace("doing recursive deletion of non-empty directory "
314
self.transport.delete_tree(tmpname)
315
self._trace("... unlock succeeded after %dms",
316
(time.time() - start_time) * 1000)
216
# rename before deleting, because we can't atomically remove the whole
218
tmpname = '%s/releasing.%s.tmp' % (self.path, rand_chars(20))
219
# gotta own it to unlock
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)
318
226
def break_lock(self):
319
227
"""Break a lock not held by this instance of LockDir.
409
321
info = self._read_info_file(self._held_info_path)
410
self._trace("peek -> held")
411
322
assert isinstance(info, dict), \
412
323
"bad parse result %r" % info
414
325
except NoSuchFile, e:
415
self._trace("peek -> not held")
417
def _prepare_info(self):
328
def _prepare_info(self, outf):
418
329
"""Write information about a pending lock to a temporary file.
421
332
# XXX: is creating this here inefficient?
422
333
config = bzrlib.config.GlobalConfig()
424
user = config.user_email()
425
except errors.NoEmailInUsername:
426
user = config.username()
427
334
s = Stanza(hostname=socket.gethostname(),
428
335
pid=str(os.getpid()),
429
336
start_time=str(int(time.time())),
430
337
nonce=self.nonce,
338
user=config.user_email(),
340
RioWriter(outf).write_stanza(s)
435
342
def _parse_info(self, info_file):
436
343
return read_stanza(info_file.readlines()).as_dict()
438
def attempt_lock(self):
439
"""Take the lock; fail if it's already held.
441
If you wish to block until the lock can be obtained, call wait_lock()
444
:return: The lock token.
445
:raises LockContention: if the lock is held by someone else.
447
if self._fake_read_lock:
448
raise LockContention(self)
449
if self.transport.is_readonly():
450
raise UnlockableTransport(self.transport)
451
return self._attempt_lock()
453
def wait_lock(self, timeout=None, poll=None, max_attempts=None):
345
def wait_lock(self, timeout=_DEFAULT_TIMEOUT_SECONDS,
346
poll=_DEFAULT_POLL_SECONDS):
454
347
"""Wait a certain period for a lock.
456
349
If the lock can be acquired within the bounded time, it
458
351
is raised. Either way, this function should return within
459
352
approximately `timeout` seconds. (It may be a bit more if
460
353
a transport operation takes a long time to complete.)
462
:param timeout: Approximate maximum amount of time to wait for the
465
:param poll: Delay in seconds between retrying the lock.
467
:param max_attempts: Maximum number of times to try to lock.
469
:return: The lock token.
472
timeout = _DEFAULT_TIMEOUT_SECONDS
474
poll = _DEFAULT_POLL_SECONDS
475
# XXX: the transport interface doesn't let us guard against operations
476
# there taking a long time, so the total elapsed time or poll interval
477
# may be more than was requested.
355
# XXX: the transport interface doesn't let us guard
356
# against operations there taking a long time.
478
357
deadline = time.time() + timeout
485
return self.attempt_lock()
486
362
except LockContention:
487
# possibly report the blockage, then try again
489
# TODO: In a few cases, we find out that there's contention by
490
# reading the held info and observing that it's not ours. In
491
# those cases it's a bit redundant to read it again. However,
492
# the normal case (??) is that the rename fails and so we
493
# don't know who holds the lock. For simplicity we peek
495
new_info = self.peek()
496
if new_info is not None and new_info != last_info:
497
if last_info is None:
498
start = 'Unable to obtain'
500
start = 'Lock owner changed for'
502
formatted_info = self._format_lock_info(new_info)
503
if deadline_str is None:
504
deadline_str = time.strftime('%H:%M:%S',
505
time.localtime(deadline))
506
self._report_function('%s %s\n'
508
'%s\n' # locked ... ago
509
'Will continue to try until %s\n',
516
if (max_attempts is not None) and (attempt_count >= max_attempts):
517
self._trace("exceeded %d attempts")
518
raise LockContention(self)
519
364
if time.time() + poll < deadline:
520
self._trace("waiting %ss", poll)
523
self._trace("timeout after waiting %ss", timeout)
524
367
raise LockContention(self)
526
def leave_in_place(self):
527
self._locked_via_token = True
529
def dont_leave_in_place(self):
530
self._locked_via_token = False
532
def lock_write(self, token=None):
533
"""Wait for and acquire the lock.
535
:param token: if this is already locked, then lock_write will fail
536
unless the token matches the existing lock.
537
:returns: a token if this instance supports tokens, otherwise None.
538
:raises TokenLockingNotSupported: when a token is given but this
539
instance doesn't support using token locks.
540
:raises MismatchedToken: if the specified token doesn't match the token
541
of the existing lock.
543
A token should be passed in if you know that you have locked the object
544
some other way, and need to synchronise this object's state with that
547
XXX: docstring duplicated from LockableFiles.lock_write.
549
if token is not None:
550
self.validate_token(token)
552
self._lock_held = True
553
self._locked_via_token = True
556
return self.wait_lock()
369
def lock_write(self):
370
"""Wait for and acquire the lock."""
558
373
def lock_read(self):
559
374
"""Compatibility-mode shared lock.
570
385
raise LockContention(self)
571
386
self._fake_read_lock = True
573
def _format_lock_info(self, info):
574
"""Turn the contents of peek() into something for the user"""
575
lock_url = self.transport.abspath(self.path)
576
delta = time.time() - int(info['start_time'])
578
'lock %s' % (lock_url,),
579
'held by %(user)s on host %(hostname)s [process #%(pid)s]' % info,
580
'locked %s' % (format_delta(delta),),
583
def validate_token(self, token):
584
if token is not None:
590
lock_token = info.get('nonce')
591
if token != lock_token:
592
raise errors.TokenMismatch(token, lock_token)
594
self._trace("revalidated by token %r", token)
596
def _trace(self, format, *args):
597
if 'lock' not in debug.debug_flags:
599
mutter(str(self) + ": " + (format % args))
388
def wait(self, timeout=20, poll=0.5):
389
"""Wait a certain period for a lock to be released."""
390
# XXX: the transport interface doesn't let us guard
391
# against operations there taking a long time.
392
deadline = time.time() + timeout
396
if time.time() + poll < deadline:
399
raise LockContention(self)
added
removed
bzrlib/lockdir.py
