← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockdir.py

  • Committer: Martin Pool
  • Date: 2009-08-20 04:53:23 UTC
  • mto: This revision was merged to the branch mainline in revision 4632.
  • Revision ID: mbp@sourcefrog.net-20090820045323-4hsicfa87pdq3l29
Correction to xdg_cache_dir and add a simple test

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, 2007, 2008 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 StringIO import StringIO
100
108
 
 
109
from bzrlib import (
 
110
    debug,
 
111
    errors,
 
112
    lock,
 
113
    )
101
114
import bzrlib.config
102
115
from bzrlib.errors import (
103
116
        DirectoryNotEmpty,
105
118
        LockBreakMismatch,
106
119
        LockBroken,
107
120
        LockContention,
 
121
        LockFailed,
108
122
        LockNotHeld,
109
123
        NoSuchFile,
110
124
        PathError,
111
125
        ResourceBusy,
112
 
        UnlockableTransport,
 
126
        TransportError,
113
127
        )
114
 
from bzrlib.trace import mutter
115
 
from bzrlib.transport import Transport
116
 
from bzrlib.osutils import rand_chars
117
 
from bzrlib.rio import RioWriter, read_stanza, Stanza
 
128
from bzrlib.trace import mutter, note
 
129
from bzrlib.osutils import format_delta, rand_chars, get_host_name
 
130
import bzrlib.ui
 
131
 
 
132
from bzrlib.lazy_import import lazy_import
 
133
lazy_import(globals(), """
 
134
from bzrlib import rio
 
135
""")
118
136
 
119
137
# XXX: At the moment there is no consideration of thread safety on LockDir
120
138
# objects.  This should perhaps be updated - e.g. if two threads try to take a
130
148
# TODO: Make sure to pass the right file and directory mode bits to all
131
149
# files/dirs created.
132
150
 
 
151
 
133
152
_DEFAULT_TIMEOUT_SECONDS = 300
134
 
_DEFAULT_POLL_SECONDS = 0.5
135
 
 
136
 
class LockDir(object):
137
 
    """Write-lock guarding access to data."""
 
153
_DEFAULT_POLL_SECONDS = 1.0
 
154
 
 
155
 
 
156
class LockDir(lock.Lock):
 
157
    """Write-lock guarding access to data.
 
158
    """
138
159
 
139
160
    __INFO_NAME = '/info'
140
161
 
145
166
 
146
167
        :param transport: Transport which will contain the lock
147
168
 
148
 
        :param path: Path to the lock within the base directory of the 
 
169
        :param path: Path to the lock within the base directory of the
149
170
            transport.
150
171
        """
151
 
        assert isinstance(transport, Transport), \
152
 
            ("not a transport: %r" % transport)
153
172
        self.transport = transport
154
173
        self.path = path
155
174
        self._lock_held = False
 
175
        self._locked_via_token = False
156
176
        self._fake_read_lock = False
157
177
        self._held_dir = path + '/held'
158
178
        self._held_info_path = self._held_dir + self.__INFO_NAME
159
179
        self._file_modebits = file_modebits
160
180
        self._dir_modebits = dir_modebits
161
 
        self.nonce = rand_chars(20)
 
181
 
 
182
        self._report_function = note
162
183
 
163
184
    def __repr__(self):
164
185
        return '%s(%s%s)' % (self.__class__.__name__,
170
191
    def create(self, mode=None):
171
192
        """Create the on-disk lock.
172
193
 
173
 
        This is typically only called when the object/directory containing the 
 
194
        This is typically only called when the object/directory containing the
174
195
        directory is first created.  The lock is not held when it's created.
175
196
        """
176
 
        if self.transport.is_readonly():
177
 
            raise UnlockableTransport(self.transport)
178
 
        self.transport.mkdir(self.path, mode=mode)
179
 
 
180
 
    def attempt_lock(self):
181
 
        """Take the lock; fail if it's already held.
182
 
        
183
 
        If you wish to block until the lock can be obtained, call wait_lock()
184
 
        instead.
 
197
        self._trace("create lock directory")
 
198
        try:
 
199
            self.transport.mkdir(self.path, mode=mode)
 
200
        except (TransportError, PathError), e:
 
201
            raise LockFailed(self, e)
 
202
 
 
203
 
 
204
    def _attempt_lock(self):
 
205
        """Make the pending directory and attempt to rename into place.
 
206
 
 
207
        If the rename succeeds, we read back the info file to check that we
 
208
        really got the lock.
 
209
 
 
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
 
212
        that yet.)
 
213
 
 
214
        :returns: The nonce of the lock, if it was successfully acquired.
 
215
 
 
216
        :raises LockContention: If the lock is held by someone else.  The exception
 
217
            contains the info of the current holder of the lock.
185
218
        """
186
 
        if self._fake_read_lock:
187
 
            raise LockContention(self)
188
 
        if self.transport.is_readonly():
189
 
            raise UnlockableTransport(self.transport)
190
 
        try:
191
 
            tmpname = '%s/pending.%s.tmp' % (self.path, rand_chars(20))
192
 
            self.transport.mkdir(tmpname)
193
 
            sio = StringIO()
194
 
            self._prepare_info(sio)
195
 
            sio.seek(0)
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
199
 
            # directory
200
 
            self.transport.append(tmpname + self.__INFO_NAME, sio)
 
219
        self._trace("lock_write...")
 
220
        start_time = time.time()
 
221
        try:
 
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)
 
226
        try:
201
227
            self.transport.rename(tmpname, self._held_dir)
202
 
            self._lock_held = True
203
 
            self.confirm()
204
 
        except (PathError, DirectoryNotEmpty, FileExists, ResourceBusy), e:
205
 
            mutter("contention on %r: %s", self, e)
206
 
            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)
 
233
        except Exception, e:
 
234
            self._trace("... lock failed, %s", e)
 
235
            self._remove_pending_dir(tmpname)
 
236
            raise
 
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.
 
243
        info = self.peek()
 
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)
 
252
        return self.nonce
 
253
 
 
254
    def _remove_pending_dir(self, tmpname):
 
255
        """Remove the pending directory
 
256
 
 
257
        This is called if we failed to rename into place, so that the pending
 
258
        dirs don't clutter up the lockdir.
 
259
        """
 
260
        self._trace("remove %s", tmpname)
 
261
        try:
 
262
            self.transport.delete(tmpname + self.__INFO_NAME)
 
263
            self.transport.rmdir(tmpname)
 
264
        except PathError, e:
 
265
            note("error removing pending lock: %s", e)
 
266
 
 
267
    def _create_pending_dir(self):
 
268
        tmpname = '%s/%s.tmp' % (self.path, rand_chars(10))
 
269
        try:
 
270
            self.transport.mkdir(tmpname)
 
271
        except NoSuchFile:
 
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
 
284
        # properties
 
285
        self.transport.put_bytes_non_atomic(tmpname + self.__INFO_NAME,
 
286
                                            info_bytes)
 
287
        return tmpname
207
288
 
208
289
    def unlock(self):
209
290
        """Release a held lock
212
293
            self._fake_read_lock = False
213
294
            return
214
295
        if not self._lock_held:
215
 
            raise LockNotHeld(self)
216
 
        # rename before deleting, because we can't atomically remove the whole
217
 
        # tree
218
 
        tmpname = '%s/releasing.%s.tmp' % (self.path, rand_chars(20))
219
 
        # gotta own it to unlock
220
 
        self.confirm()
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)
 
296
            return lock.cant_unlock_not_held(self)
 
297
        if self._locked_via_token:
 
298
            self._locked_via_token = False
 
299
            self._lock_held = False
 
300
        else:
 
301
            old_nonce = self.nonce
 
302
            # rename before deleting, because we can't atomically remove the
 
303
            # whole tree
 
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
 
308
            self.confirm()
 
309
            self.transport.rename(self._held_dir, tmpname)
 
310
            self._lock_held = False
 
311
            self.transport.delete(tmpname + self.__INFO_NAME)
 
312
            try:
 
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
 
318
                # within it.
 
319
                #
 
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 "
 
323
                        "%s", tmpname)
 
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),
 
328
                                     old_nonce)
 
329
            for hook in self.hooks['lock_released']:
 
330
                hook(result)
225
331
 
226
332
    def break_lock(self):
227
333
        """Break a lock not held by this instance of LockDir.
233
339
        self._check_not_locked()
234
340
        holder_info = self.peek()
235
341
        if holder_info is not None:
236
 
            if bzrlib.ui.ui_factory.get_boolean(
237
 
                "Break lock %s held by %s@%s [process #%s]" % (
238
 
                    self.transport,
239
 
                    holder_info["user"],
240
 
                    holder_info["hostname"],
241
 
                    holder_info["pid"])):
 
342
            lock_info = '\n'.join(self._format_lock_info(holder_info))
 
343
            if bzrlib.ui.ui_factory.get_boolean("Break %s" % lock_info):
242
344
                self.force_break(holder_info)
243
 
        
 
345
 
244
346
    def force_break(self, dead_holder_info):
245
347
        """Release a lock held by another process.
246
348
 
254
356
        LockBreakMismatch is raised.
255
357
 
256
358
        After the lock is broken it will not be held by any process.
257
 
        It is possible that another process may sneak in and take the 
 
359
        It is possible that another process may sneak in and take the
258
360
        lock before the breaking process acquires it.
259
361
        """
260
362
        if not isinstance(dead_holder_info, dict):
269
371
        tmpname = '%s/broken.%s.tmp' % (self.path, rand_chars(20))
270
372
        self.transport.rename(self._held_dir, tmpname)
271
373
        # check that we actually broke the right lock, not someone else;
272
 
        # there's a small race window between checking it and doing the 
 
374
        # there's a small race window between checking it and doing the
273
375
        # rename.
274
376
        broken_info_path = tmpname + self.__INFO_NAME
275
377
        broken_info = self._read_info_file(broken_info_path)
277
379
            raise LockBreakMismatch(self, broken_info, dead_holder_info)
278
380
        self.transport.delete(broken_info_path)
279
381
        self.transport.rmdir(tmpname)
 
382
        result = lock.LockResult(self.transport.abspath(self.path),
 
383
                                 current_info.get('nonce'))
 
384
        for hook in self.hooks['lock_broken']:
 
385
            hook(result)
280
386
 
281
387
    def _check_not_locked(self):
282
388
        """If the lock is held by this instance, raise an error."""
290
396
        or if the lock has been affected by a bug.
291
397
 
292
398
        If the lock is not thought to be held, raises LockNotHeld.  If
293
 
        the lock is thought to be held but has been broken, raises 
 
399
        the lock is thought to be held but has been broken, raises
294
400
        LockBroken.
295
401
        """
296
402
        if not self._lock_held:
302
408
        if info.get('nonce') != self.nonce:
303
409
            # there is a lock, but not ours
304
410
            raise LockBroken(self)
305
 
        
 
411
 
306
412
    def _read_info_file(self, path):
307
413
        """Read one given info file.
308
414
 
312
418
 
313
419
    def peek(self):
314
420
        """Check if the lock is held by anyone.
315
 
        
 
421
 
316
422
        If it is held, this returns the lock info structure as a rio Stanza,
317
423
        which contains some information about the current lock holder.
318
424
        Otherwise returns None.
319
425
        """
320
426
        try:
321
427
            info = self._read_info_file(self._held_info_path)
322
 
            assert isinstance(info, dict), \
323
 
                    "bad parse result %r" % info
 
428
            self._trace("peek -> held")
324
429
            return info
325
430
        except NoSuchFile, e:
326
 
            return None
 
431
            self._trace("peek -> not held")
327
432
 
328
 
    def _prepare_info(self, outf):
 
433
    def _prepare_info(self):
329
434
        """Write information about a pending lock to a temporary file.
330
435
        """
331
 
        import socket
332
436
        # XXX: is creating this here inefficient?
333
437
        config = bzrlib.config.GlobalConfig()
334
 
        s = Stanza(hostname=socket.gethostname(),
 
438
        try:
 
439
            user = config.user_email()
 
440
        except errors.NoEmailInUsername:
 
441
            user = config.username()
 
442
        s = rio.Stanza(hostname=get_host_name(),
335
443
                   pid=str(os.getpid()),
336
444
                   start_time=str(int(time.time())),
337
445
                   nonce=self.nonce,
338
 
                   user=config.user_email(),
 
446
                   user=user,
339
447
                   )
340
 
        RioWriter(outf).write_stanza(s)
 
448
        return s.to_string()
341
449
 
342
450
    def _parse_info(self, info_file):
343
 
        return read_stanza(info_file.readlines()).as_dict()
344
 
 
345
 
    def wait_lock(self, timeout=_DEFAULT_TIMEOUT_SECONDS,
346
 
                  poll=_DEFAULT_POLL_SECONDS):
 
451
        return rio.read_stanza(info_file.readlines()).as_dict()
 
452
 
 
453
    def attempt_lock(self):
 
454
        """Take the lock; fail if it's already held.
 
455
 
 
456
        If you wish to block until the lock can be obtained, call wait_lock()
 
457
        instead.
 
458
 
 
459
        :return: The lock token.
 
460
        :raises LockContention: if the lock is held by someone else.
 
461
        """
 
462
        if self._fake_read_lock:
 
463
            raise LockContention(self)
 
464
        result = self._attempt_lock()
 
465
        hook_result = lock.LockResult(self.transport.abspath(self.path),
 
466
                self.nonce)
 
467
        for hook in self.hooks['lock_acquired']:
 
468
            hook(hook_result)
 
469
        return result
 
470
 
 
471
    def wait_lock(self, timeout=None, poll=None, max_attempts=None):
347
472
        """Wait a certain period for a lock.
348
473
 
349
474
        If the lock can be acquired within the bounded time, it
351
476
        is raised.  Either way, this function should return within
352
477
        approximately `timeout` seconds.  (It may be a bit more if
353
478
        a transport operation takes a long time to complete.)
 
479
 
 
480
        :param timeout: Approximate maximum amount of time to wait for the
 
481
        lock, in seconds.
 
482
 
 
483
        :param poll: Delay in seconds between retrying the lock.
 
484
 
 
485
        :param max_attempts: Maximum number of times to try to lock.
 
486
 
 
487
        :return: The lock token.
354
488
        """
355
 
        # XXX: the transport interface doesn't let us guard 
356
 
        # against operations there taking a long time.
 
489
        if timeout is None:
 
490
            timeout = _DEFAULT_TIMEOUT_SECONDS
 
491
        if poll is None:
 
492
            poll = _DEFAULT_POLL_SECONDS
 
493
        # XXX: the transport interface doesn't let us guard against operations
 
494
        # there taking a long time, so the total elapsed time or poll interval
 
495
        # may be more than was requested.
357
496
        deadline = time.time() + timeout
 
497
        deadline_str = None
 
498
        last_info = None
 
499
        attempt_count = 0
358
500
        while True:
 
501
            attempt_count += 1
359
502
            try:
360
 
                self.attempt_lock()
361
 
                return
 
503
                return self.attempt_lock()
362
504
            except LockContention:
 
505
                # possibly report the blockage, then try again
363
506
                pass
 
507
            # TODO: In a few cases, we find out that there's contention by
 
508
            # reading the held info and observing that it's not ours.  In
 
509
            # those cases it's a bit redundant to read it again.  However,
 
510
            # the normal case (??) is that the rename fails and so we
 
511
            # don't know who holds the lock.  For simplicity we peek
 
512
            # always.
 
513
            new_info = self.peek()
 
514
            if new_info is not None and new_info != last_info:
 
515
                if last_info is None:
 
516
                    start = 'Unable to obtain'
 
517
                else:
 
518
                    start = 'Lock owner changed for'
 
519
                last_info = new_info
 
520
                formatted_info = self._format_lock_info(new_info)
 
521
                if deadline_str is None:
 
522
                    deadline_str = time.strftime('%H:%M:%S',
 
523
                                                 time.localtime(deadline))
 
524
                lock_url = self.transport.abspath(self.path)
 
525
                self._report_function('%s %s\n'
 
526
                                      '%s\n' # held by
 
527
                                      '%s\n' # locked ... ago
 
528
                                      'Will continue to try until %s, unless '
 
529
                                      'you press Ctrl-C\n'
 
530
                                      'If you\'re sure that it\'s not being '
 
531
                                      'modified, use bzr break-lock %s',
 
532
                                      start,
 
533
                                      formatted_info[0],
 
534
                                      formatted_info[1],
 
535
                                      formatted_info[2],
 
536
                                      deadline_str,
 
537
                                      lock_url)
 
538
 
 
539
            if (max_attempts is not None) and (attempt_count >= max_attempts):
 
540
                self._trace("exceeded %d attempts")
 
541
                raise LockContention(self)
364
542
            if time.time() + poll < deadline:
 
543
                self._trace("waiting %ss", poll)
365
544
                time.sleep(poll)
366
545
            else:
 
546
                self._trace("timeout after waiting %ss", timeout)
367
547
                raise LockContention(self)
368
548
 
369
 
    def lock_write(self):
370
 
        """Wait for and acquire the lock."""
371
 
        self.attempt_lock()
 
549
    def leave_in_place(self):
 
550
        self._locked_via_token = True
 
551
 
 
552
    def dont_leave_in_place(self):
 
553
        self._locked_via_token = False
 
554
 
 
555
    def lock_write(self, token=None):
 
556
        """Wait for and acquire the lock.
 
557
 
 
558
        :param token: if this is already locked, then lock_write will fail
 
559
            unless the token matches the existing lock.
 
560
        :returns: a token if this instance supports tokens, otherwise None.
 
561
        :raises TokenLockingNotSupported: when a token is given but this
 
562
            instance doesn't support using token locks.
 
563
        :raises MismatchedToken: if the specified token doesn't match the token
 
564
            of the existing lock.
 
565
 
 
566
        A token should be passed in if you know that you have locked the object
 
567
        some other way, and need to synchronise this object's state with that
 
568
        fact.
 
569
 
 
570
        XXX: docstring duplicated from LockableFiles.lock_write.
 
571
        """
 
572
        if token is not None:
 
573
            self.validate_token(token)
 
574
            self.nonce = token
 
575
            self._lock_held = True
 
576
            self._locked_via_token = True
 
577
            return token
 
578
        else:
 
579
            return self.wait_lock()
372
580
 
373
581
    def lock_read(self):
374
582
        """Compatibility-mode shared lock.
375
583
 
376
 
        LockDir doesn't support shared read-only locks, so this 
 
584
        LockDir doesn't support shared read-only locks, so this
377
585
        just pretends that the lock is taken but really does nothing.
378
586
        """
379
 
        # At the moment Branches are commonly locked for read, but 
 
587
        # At the moment Branches are commonly locked for read, but
380
588
        # we can't rely on that remotely.  Once this is cleaned up,
381
 
        # reenable this warning to prevent it coming back in 
 
589
        # reenable this warning to prevent it coming back in
382
590
        # -- mbp 20060303
383
591
        ## warn("LockDir.lock_read falls back to write lock")
384
592
        if self._lock_held or self._fake_read_lock:
385
593
            raise LockContention(self)
386
594
        self._fake_read_lock = True
387
595
 
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
393
 
        while True:
394
 
            if self.peek():
395
 
                return
396
 
            if time.time() + poll < deadline:
397
 
                time.sleep(poll)
398
 
            else:
399
 
                raise LockContention(self)
400
 
 
 
596
    def _format_lock_info(self, info):
 
597
        """Turn the contents of peek() into something for the user"""
 
598
        lock_url = self.transport.abspath(self.path)
 
599
        delta = time.time() - int(info['start_time'])
 
600
        return [
 
601
            'lock %s' % (lock_url,),
 
602
            'held by %(user)s on host %(hostname)s [process #%(pid)s]' % info,
 
603
            'locked %s' % (format_delta(delta),),
 
604
            ]
 
605
 
 
606
    def validate_token(self, token):
 
607
        if token is not None:
 
608
            info = self.peek()
 
609
            if info is None:
 
610
                # Lock isn't held
 
611
                lock_token = None
 
612
            else:
 
613
                lock_token = info.get('nonce')
 
614
            if token != lock_token:
 
615
                raise errors.TokenMismatch(token, lock_token)
 
616
            else:
 
617
                self._trace("revalidated by token %r", token)
 
618
 
 
619
    def _trace(self, format, *args):
 
620
        if 'lock' not in debug.debug_flags:
 
621
            return
 
622
        mutter(str(self) + ": " + (format % args))