/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/lockdir.py

  • Committer: Martin Pool
  • Date: 2007-06-27 09:39:45 UTC
  • mto: This revision was merged to the branch mainline in revision 2584.
  • Revision ID: mbp@sourcefrog.net-20070627093945-36tc2vu397tk1k6a
Docs on -Dlock

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockdir.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006, 2007 Canonical Ltd
2
2
#
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
12
12
#
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
16
16
 
17
17
"""On-disk mutex protecting a resource
18
18
 
21
21
internal locks (such as flock etc) because they can be seen across all
22
22
transports, including http.
23
23
 
24
 
Objects can be read if there is only physical read access; therefore
 
24
Objects can be read if there is only physical read access; therefore 
25
25
readers can never be required to create a lock, though they will
26
26
check whether a writer is using the lock.  Writers can't detect
27
27
whether anyone else is reading from the resource as they write.
56
56
 
57
57
The desired characteristics are:
58
58
 
59
 
* Locks are not reentrant.  (That is, a client that tries to take a
 
59
* Locks are not reentrant.  (That is, a client that tries to take a 
60
60
  lock it already holds may deadlock or fail.)
61
61
* Stale locks can be guessed at by a heuristic
62
62
* Lost locks can be broken by any client
78
78
and deadlocks will likely occur if the locks are aliased.
79
79
 
80
80
In the future we may add a "freshen" method which can be called
81
 
by a lock holder to check that their lock has not been broken, and to
 
81
by a lock holder to check that their lock has not been broken, and to 
82
82
update the timestamp within it.
83
83
 
84
84
Example usage:
88
88
>>> t = MemoryTransport()
89
89
>>> l = LockDir(t, 'sample-lock')
90
90
>>> l.create()
91
 
>>> token = l.wait_lock()
 
91
>>> l.wait_lock()
92
92
>>> # do something here
93
93
>>> l.unlock()
94
94
 
95
95
"""
96
96
 
97
 
 
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
105
 
 
106
97
import os
107
98
import time
 
99
from cStringIO import StringIO
108
100
 
109
101
from bzrlib import (
110
102
    debug,
111
103
    errors,
112
 
    lock,
113
 
    osutils,
114
104
    )
115
105
import bzrlib.config
116
 
from bzrlib.decorators import only_raises
117
106
from bzrlib.errors import (
118
107
        DirectoryNotEmpty,
119
108
        FileExists,
120
109
        LockBreakMismatch,
121
110
        LockBroken,
122
111
        LockContention,
123
 
        LockFailed,
124
112
        LockNotHeld,
125
113
        NoSuchFile,
126
114
        PathError,
127
115
        ResourceBusy,
128
 
        TransportError,
 
116
        UnlockableTransport,
129
117
        )
130
118
from bzrlib.trace import mutter, note
131
 
from bzrlib.osutils import format_delta, rand_chars, get_host_name
 
119
from bzrlib.transport import Transport
 
120
from bzrlib.osutils import rand_chars, format_delta
 
121
from bzrlib.rio import read_stanza, Stanza
132
122
import bzrlib.ui
133
123
 
134
 
from bzrlib.lazy_import import lazy_import
135
 
lazy_import(globals(), """
136
 
from bzrlib import rio
137
 
""")
138
124
 
139
125
# XXX: At the moment there is no consideration of thread safety on LockDir
140
126
# objects.  This should perhaps be updated - e.g. if two threads try to take a
155
141
_DEFAULT_POLL_SECONDS = 1.0
156
142
 
157
143
 
158
 
class LockDir(lock.Lock):
159
 
    """Write-lock guarding access to data.
160
 
    """
 
144
class LockDir(object):
 
145
    """Write-lock guarding access to data."""
161
146
 
162
147
    __INFO_NAME = '/info'
163
148
 
168
153
 
169
154
        :param transport: Transport which will contain the lock
170
155
 
171
 
        :param path: Path to the lock within the base directory of the
 
156
        :param path: Path to the lock within the base directory of the 
172
157
            transport.
173
158
        """
 
159
        assert isinstance(transport, Transport), \
 
160
            ("not a transport: %r" % transport)
174
161
        self.transport = transport
175
162
        self.path = path
176
163
        self._lock_held = False
193
180
    def create(self, mode=None):
194
181
        """Create the on-disk lock.
195
182
 
196
 
        This is typically only called when the object/directory containing the
 
183
        This is typically only called when the object/directory containing the 
197
184
        directory is first created.  The lock is not held when it's created.
198
185
        """
199
 
        self._trace("create lock directory")
200
 
        try:
201
 
            self.transport.mkdir(self.path, mode=mode)
202
 
        except (TransportError, PathError), e:
203
 
            raise LockFailed(self, e)
204
 
 
205
 
 
206
 
    def _attempt_lock(self):
207
 
        """Make the pending directory and attempt to rename into place.
208
 
 
209
 
        If the rename succeeds, we read back the info file to check that we
210
 
        really got the lock.
211
 
 
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
214
 
        that yet.)
215
 
 
216
 
        :returns: The nonce of the lock, if it was successfully acquired.
217
 
 
218
 
        :raises LockContention: If the lock is held by someone else.  The exception
219
 
            contains the info of the current holder of the lock.
 
186
        if self.transport.is_readonly():
 
187
            raise UnlockableTransport(self.transport)
 
188
        self.transport.mkdir(self.path, mode=mode)
 
189
 
 
190
    def attempt_lock(self):
 
191
        """Take the lock; fail if it's already held.
 
192
        
 
193
        If you wish to block until the lock can be obtained, call wait_lock()
 
194
        instead.
 
195
 
 
196
        :return: The lock token.
220
197
        """
221
 
        self._trace("lock_write...")
222
 
        start_time = time.time()
223
 
        try:
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)
228
 
        try:
 
198
        if self._fake_read_lock:
 
199
            raise LockContention(self)
 
200
        if self.transport.is_readonly():
 
201
            raise UnlockableTransport(self.transport)
 
202
        try:
 
203
            self._trace("lock_write...")
 
204
            start_time = time.time()
 
205
            tmpname = '%s/pending.%s.tmp' % (self.path, rand_chars(20))
 
206
            try:
 
207
                self.transport.mkdir(tmpname)
 
208
            except NoSuchFile:
 
209
                # This may raise a FileExists exception
 
210
                # which is okay, it will be caught later and determined
 
211
                # to be a LockContention.
 
212
                self.create(mode=self._dir_modebits)
 
213
                
 
214
                # After creating the lock directory, try again
 
215
                self.transport.mkdir(tmpname)
 
216
 
 
217
            self.nonce = rand_chars(20)
 
218
            info_bytes = self._prepare_info()
 
219
            # We use put_file_non_atomic because we just created a new unique
 
220
            # directory so we don't have to worry about files existing there.
 
221
            # We'll rename the whole directory into place to get atomic
 
222
            # properties
 
223
            self.transport.put_bytes_non_atomic(tmpname + self.__INFO_NAME,
 
224
                                                info_bytes)
 
225
 
229
226
            self.transport.rename(tmpname, self._held_dir)
230
 
        except (errors.TransportError, PathError, DirectoryNotEmpty,
231
 
                FileExists, ResourceBusy), e:
 
227
            self._lock_held = True
 
228
            # we used to do self.confirm() at this point, but it's really
 
229
            # unnecessary, we have no substantial chance of having it broken
 
230
            # just as it's acquired, and we believe that this lock design is
 
231
            # safe on all platforms.
 
232
            # FIXME: we should remove the pending lock if we fail, 
 
233
            # https://bugs.launchpad.net/bzr/+bug/109169
 
234
        except errors.PermissionDenied:
 
235
            self._trace("... lock failed, permission denied")
 
236
            raise
 
237
        except (PathError, DirectoryNotEmpty, FileExists, ResourceBusy), e:
232
238
            self._trace("... contention, %s", e)
233
 
            self._remove_pending_dir(tmpname)
234
 
            raise LockContention(self)
235
 
        except Exception, e:
236
 
            self._trace("... lock failed, %s", e)
237
 
            self._remove_pending_dir(tmpname)
238
 
            raise
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.
245
 
        #
246
 
        # See <https://bugs.edge.launchpad.net/bzr/+bug/498378> for one case.
247
 
        #
248
 
        # Strictly the check is unnecessary and a waste of time for most
249
 
        # people, but probably worth trapping if something is wrong.
250
 
        info = self.peek()
251
 
        self._trace("after locking, info=%r", info)
252
 
        if info is None:
253
 
            raise LockFailed(self, "lock was renamed into place, but "
254
 
                "now is missing!")
255
 
        if info.get('nonce') != self.nonce:
256
 
            self._trace("rename succeeded, "
257
 
                "but lock is still held by someone else")
258
 
            raise LockContention(self)
259
 
        self._lock_held = True
 
239
            raise LockContention(self)
260
240
        self._trace("... lock succeeded after %dms",
261
241
                (time.time() - start_time) * 1000)
262
242
        return self.nonce
263
243
 
264
 
    def _remove_pending_dir(self, tmpname):
265
 
        """Remove the pending directory
266
 
 
267
 
        This is called if we failed to rename into place, so that the pending
268
 
        dirs don't clutter up the lockdir.
269
 
        """
270
 
        self._trace("remove %s", tmpname)
271
 
        try:
272
 
            self.transport.delete(tmpname + self.__INFO_NAME)
273
 
            self.transport.rmdir(tmpname)
274
 
        except PathError, e:
275
 
            note("error removing pending lock: %s", e)
276
 
 
277
 
    def _create_pending_dir(self):
278
 
        tmpname = '%s/%s.tmp' % (self.path, rand_chars(10))
279
 
        try:
280
 
            self.transport.mkdir(tmpname)
281
 
        except NoSuchFile:
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
294
 
        # properties
295
 
        self.transport.put_bytes_non_atomic(tmpname + self.__INFO_NAME,
296
 
                                            info_bytes)
297
 
        return tmpname
298
 
 
299
 
    @only_raises(LockNotHeld, LockBroken)
300
244
    def unlock(self):
301
245
        """Release a held lock
302
246
        """
304
248
            self._fake_read_lock = False
305
249
            return
306
250
        if not self._lock_held:
307
 
            return lock.cant_unlock_not_held(self)
 
251
            raise LockNotHeld(self)
308
252
        if self._locked_via_token:
309
253
            self._locked_via_token = False
310
254
            self._lock_held = False
311
255
        else:
312
 
            old_nonce = self.nonce
313
256
            # rename before deleting, because we can't atomically remove the
314
257
            # whole tree
315
258
            start_time = time.time()
320
263
            self.transport.rename(self._held_dir, tmpname)
321
264
            self._lock_held = False
322
265
            self.transport.delete(tmpname + self.__INFO_NAME)
323
 
            try:
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
329
 
                # within it.
330
 
                #
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 "
334
 
                        "%s", tmpname)
335
 
                self.transport.delete_tree(tmpname)
 
266
            self.transport.rmdir(tmpname)
336
267
            self._trace("... unlock succeeded after %dms",
337
268
                    (time.time() - start_time) * 1000)
338
 
            result = lock.LockResult(self.transport.abspath(self.path),
339
 
                                     old_nonce)
340
 
            for hook in self.hooks['lock_released']:
341
 
                hook(result)
342
269
 
343
270
    def break_lock(self):
344
271
        """Break a lock not held by this instance of LockDir.
353
280
            lock_info = '\n'.join(self._format_lock_info(holder_info))
354
281
            if bzrlib.ui.ui_factory.get_boolean("Break %s" % lock_info):
355
282
                self.force_break(holder_info)
356
 
 
 
283
        
357
284
    def force_break(self, dead_holder_info):
358
285
        """Release a lock held by another process.
359
286
 
367
294
        LockBreakMismatch is raised.
368
295
 
369
296
        After the lock is broken it will not be held by any process.
370
 
        It is possible that another process may sneak in and take the
 
297
        It is possible that another process may sneak in and take the 
371
298
        lock before the breaking process acquires it.
372
299
        """
373
300
        if not isinstance(dead_holder_info, dict):
382
309
        tmpname = '%s/broken.%s.tmp' % (self.path, rand_chars(20))
383
310
        self.transport.rename(self._held_dir, tmpname)
384
311
        # check that we actually broke the right lock, not someone else;
385
 
        # there's a small race window between checking it and doing the
 
312
        # there's a small race window between checking it and doing the 
386
313
        # rename.
387
314
        broken_info_path = tmpname + self.__INFO_NAME
388
315
        broken_info = self._read_info_file(broken_info_path)
390
317
            raise LockBreakMismatch(self, broken_info, dead_holder_info)
391
318
        self.transport.delete(broken_info_path)
392
319
        self.transport.rmdir(tmpname)
393
 
        result = lock.LockResult(self.transport.abspath(self.path),
394
 
                                 current_info.get('nonce'))
395
 
        for hook in self.hooks['lock_broken']:
396
 
            hook(result)
397
320
 
398
321
    def _check_not_locked(self):
399
322
        """If the lock is held by this instance, raise an error."""
407
330
        or if the lock has been affected by a bug.
408
331
 
409
332
        If the lock is not thought to be held, raises LockNotHeld.  If
410
 
        the lock is thought to be held but has been broken, raises
 
333
        the lock is thought to be held but has been broken, raises 
411
334
        LockBroken.
412
335
        """
413
336
        if not self._lock_held:
419
342
        if info.get('nonce') != self.nonce:
420
343
            # there is a lock, but not ours
421
344
            raise LockBroken(self)
422
 
 
 
345
        
423
346
    def _read_info_file(self, path):
424
347
        """Read one given info file.
425
348
 
426
349
        peek() reads the info file of the lock holder, if any.
427
350
        """
428
 
        return self._parse_info(self.transport.get_bytes(path))
 
351
        return self._parse_info(self.transport.get(path))
429
352
 
430
353
    def peek(self):
431
354
        """Check if the lock is held by anyone.
432
 
 
433
 
        If it is held, this returns the lock info structure as a dict
 
355
        
 
356
        If it is held, this returns the lock info structure as a rio Stanza,
434
357
        which contains some information about the current lock holder.
435
358
        Otherwise returns None.
436
359
        """
437
360
        try:
438
361
            info = self._read_info_file(self._held_info_path)
439
362
            self._trace("peek -> held")
 
363
            assert isinstance(info, dict), \
 
364
                    "bad parse result %r" % info
440
365
            return info
441
366
        except NoSuchFile, e:
442
367
            self._trace("peek -> not held")
444
369
    def _prepare_info(self):
445
370
        """Write information about a pending lock to a temporary file.
446
371
        """
 
372
        import socket
447
373
        # XXX: is creating this here inefficient?
448
374
        config = bzrlib.config.GlobalConfig()
449
375
        try:
450
376
            user = config.user_email()
451
377
        except errors.NoEmailInUsername:
452
378
            user = config.username()
453
 
        s = rio.Stanza(hostname=get_host_name(),
 
379
        s = Stanza(hostname=socket.gethostname(),
454
380
                   pid=str(os.getpid()),
455
381
                   start_time=str(int(time.time())),
456
382
                   nonce=self.nonce,
458
384
                   )
459
385
        return s.to_string()
460
386
 
461
 
    def _parse_info(self, info_bytes):
462
 
        stanza = rio.read_stanza(osutils.split_lines(info_bytes))
463
 
        if stanza is None:
464
 
            # see bug 185013; we fairly often end up with the info file being
465
 
            # empty after an interruption; we could log a message here but
466
 
            # there may not be much we can say
467
 
            return {}
468
 
        else:
469
 
            return stanza.as_dict()
470
 
 
471
 
    def attempt_lock(self):
472
 
        """Take the lock; fail if it's already held.
473
 
 
474
 
        If you wish to block until the lock can be obtained, call wait_lock()
475
 
        instead.
476
 
 
477
 
        :return: The lock token.
478
 
        :raises LockContention: if the lock is held by someone else.
479
 
        """
480
 
        if self._fake_read_lock:
481
 
            raise LockContention(self)
482
 
        result = self._attempt_lock()
483
 
        hook_result = lock.LockResult(self.transport.abspath(self.path),
484
 
                self.nonce)
485
 
        for hook in self.hooks['lock_acquired']:
486
 
            hook(hook_result)
487
 
        return result
488
 
 
489
 
    def wait_lock(self, timeout=None, poll=None, max_attempts=None):
 
387
    def _parse_info(self, info_file):
 
388
        return read_stanza(info_file.readlines()).as_dict()
 
389
 
 
390
    def wait_lock(self, timeout=None, poll=None):
490
391
        """Wait a certain period for a lock.
491
392
 
492
393
        If the lock can be acquired within the bounded time, it
495
396
        approximately `timeout` seconds.  (It may be a bit more if
496
397
        a transport operation takes a long time to complete.)
497
398
 
498
 
        :param timeout: Approximate maximum amount of time to wait for the
499
 
        lock, in seconds.
500
 
 
501
 
        :param poll: Delay in seconds between retrying the lock.
502
 
 
503
 
        :param max_attempts: Maximum number of times to try to lock.
504
 
 
505
399
        :return: The lock token.
506
400
        """
507
401
        if timeout is None:
508
402
            timeout = _DEFAULT_TIMEOUT_SECONDS
509
403
        if poll is None:
510
404
            poll = _DEFAULT_POLL_SECONDS
511
 
        # XXX: the transport interface doesn't let us guard against operations
512
 
        # there taking a long time, so the total elapsed time or poll interval
513
 
        # may be more than was requested.
 
405
 
 
406
        # XXX: the transport interface doesn't let us guard 
 
407
        # against operations there taking a long time.
514
408
        deadline = time.time() + timeout
515
409
        deadline_str = None
516
410
        last_info = None
517
 
        attempt_count = 0
518
411
        while True:
519
 
            attempt_count += 1
520
412
            try:
521
413
                return self.attempt_lock()
522
414
            except LockContention:
523
 
                # possibly report the blockage, then try again
524
415
                pass
525
 
            # TODO: In a few cases, we find out that there's contention by
526
 
            # reading the held info and observing that it's not ours.  In
527
 
            # those cases it's a bit redundant to read it again.  However,
528
 
            # the normal case (??) is that the rename fails and so we
529
 
            # don't know who holds the lock.  For simplicity we peek
530
 
            # always.
531
416
            new_info = self.peek()
 
417
            self._trace('last_info: %s, new info: %s', last_info, new_info)
532
418
            if new_info is not None and new_info != last_info:
533
419
                if last_info is None:
534
420
                    start = 'Unable to obtain'
539
425
                if deadline_str is None:
540
426
                    deadline_str = time.strftime('%H:%M:%S',
541
427
                                                 time.localtime(deadline))
542
 
                lock_url = self.transport.abspath(self.path)
543
 
                # See <https://bugs.edge.launchpad.net/bzr/+bug/250451>
544
 
                # the URL here is sometimes not one that is useful to the
545
 
                # user, perhaps being wrapped in a lp-%d or chroot decorator,
546
 
                # especially if this error is issued from the server.
547
428
                self._report_function('%s %s\n'
548
 
                    '%s\n' # held by
549
 
                    '%s\n' # locked ... ago
550
 
                    'Will continue to try until %s, unless '
551
 
                    'you press Ctrl-C.\n'
552
 
                    'See "bzr help break-lock" for more.',
553
 
                    start,
554
 
                    formatted_info[0],
555
 
                    formatted_info[1],
556
 
                    formatted_info[2],
557
 
                    deadline_str,
558
 
                    )
 
429
                                      '%s\n' # held by
 
430
                                      '%s\n' # locked ... ago
 
431
                                      'Will continue to try until %s\n',
 
432
                                      start,
 
433
                                      formatted_info[0],
 
434
                                      formatted_info[1],
 
435
                                      formatted_info[2],
 
436
                                      deadline_str)
559
437
 
560
 
            if (max_attempts is not None) and (attempt_count >= max_attempts):
561
 
                self._trace("exceeded %d attempts")
562
 
                raise LockContention(self)
563
438
            if time.time() + poll < deadline:
564
439
                self._trace("waiting %ss", poll)
565
440
                time.sleep(poll)
566
441
            else:
567
442
                self._trace("timeout after waiting %ss", timeout)
568
443
                raise LockContention(self)
569
 
 
 
444
    
570
445
    def leave_in_place(self):
571
446
        self._locked_via_token = True
572
447
 
575
450
 
576
451
    def lock_write(self, token=None):
577
452
        """Wait for and acquire the lock.
578
 
 
 
453
        
579
454
        :param token: if this is already locked, then lock_write will fail
580
455
            unless the token matches the existing lock.
581
456
        :returns: a token if this instance supports tokens, otherwise None.
587
462
        A token should be passed in if you know that you have locked the object
588
463
        some other way, and need to synchronise this object's state with that
589
464
        fact.
590
 
 
 
465
         
591
466
        XXX: docstring duplicated from LockableFiles.lock_write.
592
467
        """
593
468
        if token is not None:
602
477
    def lock_read(self):
603
478
        """Compatibility-mode shared lock.
604
479
 
605
 
        LockDir doesn't support shared read-only locks, so this
 
480
        LockDir doesn't support shared read-only locks, so this 
606
481
        just pretends that the lock is taken but really does nothing.
607
482
        """
608
 
        # At the moment Branches are commonly locked for read, but
 
483
        # At the moment Branches are commonly locked for read, but 
609
484
        # we can't rely on that remotely.  Once this is cleaned up,
610
 
        # reenable this warning to prevent it coming back in
 
485
        # reenable this warning to prevent it coming back in 
611
486
        # -- mbp 20060303
612
487
        ## warn("LockDir.lock_read falls back to write lock")
613
488
        if self._lock_held or self._fake_read_lock:
614
489
            raise LockContention(self)
615
490
        self._fake_read_lock = True
616
491
 
 
492
    def wait(self, timeout=20, poll=0.5):
 
493
        """Wait a certain period for a lock to be released."""
 
494
        # XXX: the transport interface doesn't let us guard 
 
495
        # against operations there taking a long time.
 
496
        #
 
497
        # XXX: Is this really needed?  Do people want to wait for the lock but
 
498
        # not acquire it?  As of bzr 0.17, this seems to only be called from
 
499
        # the test suite.
 
500
        deadline = time.time() + timeout
 
501
        while True:
 
502
            if self.peek():
 
503
                return
 
504
            if time.time() + poll < deadline:
 
505
                self._trace("waiting %ss", poll)
 
506
                time.sleep(poll)
 
507
            else:
 
508
                self._trace("temeout after waiting %ss", timeout)
 
509
                raise LockContention(self)
 
510
 
617
511
    def _format_lock_info(self, info):
618
512
        """Turn the contents of peek() into something for the user"""
619
513
        lock_url = self.transport.abspath(self.path)
620
 
        start_time = info.get('start_time')
621
 
        if start_time is None:
622
 
            time_ago = '(unknown)'
623
 
        else:
624
 
            time_ago = format_delta(time.time() - int(info['start_time']))
 
514
        delta = time.time() - int(info['start_time'])
625
515
        return [
626
516
            'lock %s' % (lock_url,),
627
 
            'held by %s on host %s [process #%s]' %
628
 
                tuple([info.get(x, '<unknown>') for x in ['user', 'hostname', 'pid']]),
629
 
            'locked %s' % (time_ago,),
 
517
            'held by %(user)s on host %(hostname)s [process #%(pid)s]' % info,
 
518
            'locked %s' % (format_delta(delta),),
630
519
            ]
631
520
 
632
521
    def validate_token(self, token):
640
529
            if token != lock_token:
641
530
                raise errors.TokenMismatch(token, lock_token)
642
531
            else:
643
 
                self._trace("revalidated by token %r", token)
 
532
                self._trace("Revalidated by token %r", token)
644
533
 
645
534
    def _trace(self, format, *args):
646
535
        if 'lock' not in debug.debug_flags: