← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockdir.py

  • Committer: Robert Collins
  • Date: 2010-05-06 23:54:05 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506235405-wii4elupfhzl3jvy
Add __str__ to the new helper classes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockdir.py
1
 
# Copyright (C) 2006 Canonical Ltd
 
1
# Copyright (C) 2006-2010 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
 
>>> l.wait_lock()
 
91
>>> token = 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
 
97
106
import os
98
107
import time
99
 
from cStringIO import StringIO
100
108
 
101
109
from bzrlib import (
 
110
    debug,
102
111
    errors,
 
112
    lock,
 
113
    osutils,
103
114
    )
104
115
import bzrlib.config
 
116
from bzrlib.decorators import only_raises
105
117
from bzrlib.errors import (
106
118
        DirectoryNotEmpty,
107
119
        FileExists,
108
120
        LockBreakMismatch,
109
121
        LockBroken,
110
122
        LockContention,
 
123
        LockFailed,
111
124
        LockNotHeld,
112
125
        NoSuchFile,
113
126
        PathError,
114
127
        ResourceBusy,
115
 
        UnlockableTransport,
 
128
        TransportError,
116
129
        )
117
130
from bzrlib.trace import mutter, note
118
 
from bzrlib.transport import Transport
119
 
from bzrlib.osutils import rand_chars, format_delta
120
 
from bzrlib.rio import read_stanza, Stanza
 
131
from bzrlib.osutils import format_delta, rand_chars, get_host_name
121
132
import bzrlib.ui
122
133
 
 
134
from bzrlib.lazy_import import lazy_import
 
135
lazy_import(globals(), """
 
136
from bzrlib import rio
 
137
""")
123
138
 
124
139
# XXX: At the moment there is no consideration of thread safety on LockDir
125
140
# objects.  This should perhaps be updated - e.g. if two threads try to take a
140
155
_DEFAULT_POLL_SECONDS = 1.0
141
156
 
142
157
 
143
 
class LockDir(object):
144
 
    """Write-lock guarding access to data."""
 
158
class LockDir(lock.Lock):
 
159
    """Write-lock guarding access to data.
 
160
    """
145
161
 
146
162
    __INFO_NAME = '/info'
147
163
 
152
168
 
153
169
        :param transport: Transport which will contain the lock
154
170
 
155
 
        :param path: Path to the lock within the base directory of the 
 
171
        :param path: Path to the lock within the base directory of the
156
172
            transport.
157
173
        """
158
 
        assert isinstance(transport, Transport), \
159
 
            ("not a transport: %r" % transport)
160
174
        self.transport = transport
161
175
        self.path = path
162
176
        self._lock_held = False
179
193
    def create(self, mode=None):
180
194
        """Create the on-disk lock.
181
195
 
182
 
        This is typically only called when the object/directory containing the 
 
196
        This is typically only called when the object/directory containing the
183
197
        directory is first created.  The lock is not held when it's created.
184
198
        """
185
 
        if self.transport.is_readonly():
186
 
            raise UnlockableTransport(self.transport)
187
 
        self.transport.mkdir(self.path, mode=mode)
188
 
 
189
 
    def attempt_lock(self):
190
 
        """Take the lock; fail if it's already held.
191
 
        
192
 
        If you wish to block until the lock can be obtained, call wait_lock()
193
 
        instead.
 
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.
194
220
        """
195
 
        if self._fake_read_lock:
196
 
            raise LockContention(self)
197
 
        if self.transport.is_readonly():
198
 
            raise UnlockableTransport(self.transport)
199
 
        try:
200
 
            tmpname = '%s/pending.%s.tmp' % (self.path, rand_chars(20))
201
 
            try:
202
 
                self.transport.mkdir(tmpname)
203
 
            except NoSuchFile:
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)
208
 
                
209
 
                # After creating the lock directory, try again
210
 
                self.transport.mkdir(tmpname)
211
 
 
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
217
 
            # properties
218
 
            self.transport.put_bytes_non_atomic(tmpname + self.__INFO_NAME,
219
 
                                                info_bytes)
220
 
 
 
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:
221
229
            self.transport.rename(tmpname, self._held_dir)
222
 
            self._lock_held = True
223
 
            self.confirm()
224
 
        except errors.PermissionDenied:
 
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)
 
235
        except Exception, e:
 
236
            self._trace("... lock failed, %s", e)
 
237
            self._remove_pending_dir(tmpname)
225
238
            raise
226
 
        except (PathError, DirectoryNotEmpty, FileExists, ResourceBusy), e:
227
 
            mutter("contention on %r: %s", self, e)
 
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")
228
258
            raise LockContention(self)
229
 
 
 
259
        self._lock_held = True
 
260
        self._trace("... lock succeeded after %dms",
 
261
                (time.time() - start_time) * 1000)
 
262
        return self.nonce
 
263
 
 
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)
230
300
    def unlock(self):
231
301
        """Release a held lock
232
302
        """
234
304
            self._fake_read_lock = False
235
305
            return
236
306
        if not self._lock_held:
237
 
            raise LockNotHeld(self)
 
307
            return lock.cant_unlock_not_held(self)
238
308
        if self._locked_via_token:
239
309
            self._locked_via_token = False
240
310
            self._lock_held = False
241
311
        else:
 
312
            old_nonce = self.nonce
242
313
            # rename before deleting, because we can't atomically remove the
243
314
            # whole tree
 
315
            start_time = time.time()
 
316
            self._trace("unlocking")
244
317
            tmpname = '%s/releasing.%s.tmp' % (self.path, rand_chars(20))
245
318
            # gotta own it to unlock
246
319
            self.confirm()
247
320
            self.transport.rename(self._held_dir, tmpname)
248
321
            self._lock_held = False
249
322
            self.transport.delete(tmpname + self.__INFO_NAME)
250
 
            self.transport.rmdir(tmpname)
 
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)
 
336
            self._trace("... unlock succeeded after %dms",
 
337
                    (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)
251
342
 
252
343
    def break_lock(self):
253
344
        """Break a lock not held by this instance of LockDir.
262
353
            lock_info = '\n'.join(self._format_lock_info(holder_info))
263
354
            if bzrlib.ui.ui_factory.get_boolean("Break %s" % lock_info):
264
355
                self.force_break(holder_info)
265
 
        
 
356
 
266
357
    def force_break(self, dead_holder_info):
267
358
        """Release a lock held by another process.
268
359
 
276
367
        LockBreakMismatch is raised.
277
368
 
278
369
        After the lock is broken it will not be held by any process.
279
 
        It is possible that another process may sneak in and take the 
 
370
        It is possible that another process may sneak in and take the
280
371
        lock before the breaking process acquires it.
281
372
        """
282
373
        if not isinstance(dead_holder_info, dict):
291
382
        tmpname = '%s/broken.%s.tmp' % (self.path, rand_chars(20))
292
383
        self.transport.rename(self._held_dir, tmpname)
293
384
        # check that we actually broke the right lock, not someone else;
294
 
        # there's a small race window between checking it and doing the 
 
385
        # there's a small race window between checking it and doing the
295
386
        # rename.
296
387
        broken_info_path = tmpname + self.__INFO_NAME
297
388
        broken_info = self._read_info_file(broken_info_path)
299
390
            raise LockBreakMismatch(self, broken_info, dead_holder_info)
300
391
        self.transport.delete(broken_info_path)
301
392
        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)
302
397
 
303
398
    def _check_not_locked(self):
304
399
        """If the lock is held by this instance, raise an error."""
312
407
        or if the lock has been affected by a bug.
313
408
 
314
409
        If the lock is not thought to be held, raises LockNotHeld.  If
315
 
        the lock is thought to be held but has been broken, raises 
 
410
        the lock is thought to be held but has been broken, raises
316
411
        LockBroken.
317
412
        """
318
413
        if not self._lock_held:
324
419
        if info.get('nonce') != self.nonce:
325
420
            # there is a lock, but not ours
326
421
            raise LockBroken(self)
327
 
        
 
422
 
328
423
    def _read_info_file(self, path):
329
424
        """Read one given info file.
330
425
 
331
426
        peek() reads the info file of the lock holder, if any.
332
427
        """
333
 
        return self._parse_info(self.transport.get(path))
 
428
        return self._parse_info(self.transport.get_bytes(path))
334
429
 
335
430
    def peek(self):
336
431
        """Check if the lock is held by anyone.
337
 
        
338
 
        If it is held, this returns the lock info structure as a rio Stanza,
 
432
 
 
433
        If it is held, this returns the lock info structure as a dict
339
434
        which contains some information about the current lock holder.
340
435
        Otherwise returns None.
341
436
        """
342
437
        try:
343
438
            info = self._read_info_file(self._held_info_path)
344
 
            assert isinstance(info, dict), \
345
 
                    "bad parse result %r" % info
 
439
            self._trace("peek -> held")
346
440
            return info
347
441
        except NoSuchFile, e:
348
 
            return None
 
442
            self._trace("peek -> not held")
349
443
 
350
444
    def _prepare_info(self):
351
445
        """Write information about a pending lock to a temporary file.
352
446
        """
353
 
        import socket
354
447
        # XXX: is creating this here inefficient?
355
448
        config = bzrlib.config.GlobalConfig()
356
449
        try:
357
450
            user = config.user_email()
358
451
        except errors.NoEmailInUsername:
359
452
            user = config.username()
360
 
        s = Stanza(hostname=socket.gethostname(),
 
453
        s = rio.Stanza(hostname=get_host_name(),
361
454
                   pid=str(os.getpid()),
362
455
                   start_time=str(int(time.time())),
363
456
                   nonce=self.nonce,
365
458
                   )
366
459
        return s.to_string()
367
460
 
368
 
    def _parse_info(self, info_file):
369
 
        return read_stanza(info_file.readlines()).as_dict()
370
 
 
371
 
    def wait_lock(self, timeout=None, poll=None):
 
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):
372
490
        """Wait a certain period for a lock.
373
491
 
374
492
        If the lock can be acquired within the bounded time, it
376
494
        is raised.  Either way, this function should return within
377
495
        approximately `timeout` seconds.  (It may be a bit more if
378
496
        a transport operation takes a long time to complete.)
 
497
 
 
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
        :return: The lock token.
379
506
        """
380
507
        if timeout is None:
381
508
            timeout = _DEFAULT_TIMEOUT_SECONDS
382
509
        if poll is None:
383
510
            poll = _DEFAULT_POLL_SECONDS
384
 
 
385
 
        # XXX: the transport interface doesn't let us guard 
386
 
        # against operations there taking a long time.
 
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.
387
514
        deadline = time.time() + timeout
388
515
        deadline_str = None
389
516
        last_info = None
 
517
        attempt_count = 0
390
518
        while True:
 
519
            attempt_count += 1
391
520
            try:
392
 
                self.attempt_lock()
393
 
                return
 
521
                return self.attempt_lock()
394
522
            except LockContention:
 
523
                # possibly report the blockage, then try again
395
524
                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.
396
531
            new_info = self.peek()
397
 
            mutter('last_info: %s, new info: %s', last_info, new_info)
398
532
            if new_info is not None and new_info != last_info:
399
533
                if last_info is None:
400
534
                    start = 'Unable to obtain'
405
539
                if deadline_str is None:
406
540
                    deadline_str = time.strftime('%H:%M:%S',
407
541
                                                 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.
408
547
                self._report_function('%s %s\n'
409
 
                                      '%s\n' # held by
410
 
                                      '%s\n' # locked ... ago
411
 
                                      'Will continue to try until %s\n',
412
 
                                      start,
413
 
                                      formatted_info[0],
414
 
                                      formatted_info[1],
415
 
                                      formatted_info[2],
416
 
                                      deadline_str)
 
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
                    )
417
559
 
 
560
            if (max_attempts is not None) and (attempt_count >= max_attempts):
 
561
                self._trace("exceeded %d attempts")
 
562
                raise LockContention(self)
418
563
            if time.time() + poll < deadline:
 
564
                self._trace("waiting %ss", poll)
419
565
                time.sleep(poll)
420
566
            else:
 
567
                self._trace("timeout after waiting %ss", timeout)
421
568
                raise LockContention(self)
422
 
    
 
569
 
423
570
    def leave_in_place(self):
424
571
        self._locked_via_token = True
425
572
 
428
575
 
429
576
    def lock_write(self, token=None):
430
577
        """Wait for and acquire the lock.
431
 
        
 
578
 
432
579
        :param token: if this is already locked, then lock_write will fail
433
580
            unless the token matches the existing lock.
434
581
        :returns: a token if this instance supports tokens, otherwise None.
440
587
        A token should be passed in if you know that you have locked the object
441
588
        some other way, and need to synchronise this object's state with that
442
589
        fact.
443
 
         
 
590
 
444
591
        XXX: docstring duplicated from LockableFiles.lock_write.
445
592
        """
446
593
        if token is not None:
450
597
            self._locked_via_token = True
451
598
            return token
452
599
        else:
453
 
            self.wait_lock()
454
 
            return self.peek().get('nonce')
 
600
            return self.wait_lock()
455
601
 
456
602
    def lock_read(self):
457
603
        """Compatibility-mode shared lock.
458
604
 
459
 
        LockDir doesn't support shared read-only locks, so this 
 
605
        LockDir doesn't support shared read-only locks, so this
460
606
        just pretends that the lock is taken but really does nothing.
461
607
        """
462
 
        # At the moment Branches are commonly locked for read, but 
 
608
        # At the moment Branches are commonly locked for read, but
463
609
        # we can't rely on that remotely.  Once this is cleaned up,
464
 
        # reenable this warning to prevent it coming back in 
 
610
        # reenable this warning to prevent it coming back in
465
611
        # -- mbp 20060303
466
612
        ## warn("LockDir.lock_read falls back to write lock")
467
613
        if self._lock_held or self._fake_read_lock:
468
614
            raise LockContention(self)
469
615
        self._fake_read_lock = True
470
616
 
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
476
 
        while True:
477
 
            if self.peek():
478
 
                return
479
 
            if time.time() + poll < deadline:
480
 
                time.sleep(poll)
481
 
            else:
482
 
                raise LockContention(self)
483
 
 
484
617
    def _format_lock_info(self, info):
485
618
        """Turn the contents of peek() into something for the user"""
486
619
        lock_url = self.transport.abspath(self.path)
487
 
        delta = time.time() - int(info['start_time'])
 
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']))
488
625
        return [
489
626
            'lock %s' % (lock_url,),
490
 
            'held by %(user)s on host %(hostname)s [process #%(pid)s]' % info,
491
 
            'locked %s' % (format_delta(delta),),
 
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,),
492
630
            ]
493
631
 
494
632
    def validate_token(self, token):
501
639
                lock_token = info.get('nonce')
502
640
            if token != lock_token:
503
641
                raise errors.TokenMismatch(token, lock_token)
 
642
            else:
 
643
                self._trace("revalidated by token %r", token)
504
644
 
 
645
    def _trace(self, format, *args):
 
646
        if 'lock' not in debug.debug_flags:
 
647
            return
 
648
        mutter(str(self) + ": " + (format % args))